New upstream version 1.14.14+repack

This commit is contained in:
TANIGUCHI Takaki 2020-02-11 11:48:00 +09:00
parent ae93fbf999
commit a332cfe450
108 changed files with 15486 additions and 4621 deletions

View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.13.37
Version: 1.14.14
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@ -22,7 +22,7 @@ Description: botocore
`boto3 <https://github.com/boto/boto3>`__.
On 10/09/2019 support for Python 2.6 and Python 3.3 was deprecated and support
will be dropped on 01/10/2020. To avoid disruption, customers using Botocore
was dropped on 01/10/2020. To avoid disruption, customers using Botocore
on Python 2.6 or 3.3 will need to upgrade their version of Python or pin the
version of Botocore in use prior to 01/10/2020. For more information, see
this `blog post <https://aws.amazon.com/blogs/developer/deprecation-of-python-2-6-and-python-3-3-in-botocore-boto3-and-the-aws-cli/>`__.
@ -54,11 +54,10 @@ Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8

View file

@ -14,7 +14,7 @@ botocore package is the foundation for the
`boto3 <https://github.com/boto/boto3>`__.
On 10/09/2019 support for Python 2.6 and Python 3.3 was deprecated and support
will be dropped on 01/10/2020. To avoid disruption, customers using Botocore
was dropped on 01/10/2020. To avoid disruption, customers using Botocore
on Python 2.6 or 3.3 will need to upgrade their version of Python or pin the
version of Botocore in use prior to 01/10/2020. For more information, see
this `blog post <https://aws.amazon.com/blogs/developer/deprecation-of-python-2-6-and-python-3-3-in-botocore-boto3-and-the-aws-cli/>`__.

View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.13.37
Version: 1.14.14
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@ -22,7 +22,7 @@ Description: botocore
`boto3 <https://github.com/boto/boto3>`__.
On 10/09/2019 support for Python 2.6 and Python 3.3 was deprecated and support
will be dropped on 01/10/2020. To avoid disruption, customers using Botocore
was dropped on 01/10/2020. To avoid disruption, customers using Botocore
on Python 2.6 or 3.3 will need to upgrade their version of Python or pin the
version of Botocore in use prior to 01/10/2020. For more information, see
this `blog post <https://aws.amazon.com/blogs/developer/deprecation-of-python-2-6-and-python-3-3-in-botocore-boto3-and-the-aws-cli/>`__.
@ -54,11 +54,10 @@ Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8

View file

@ -207,6 +207,8 @@ botocore/data/codeguruprofiler/2019-07-18/service-2.json
botocore/data/codepipeline/2015-07-09/examples-1.json
botocore/data/codepipeline/2015-07-09/paginators-1.json
botocore/data/codepipeline/2015-07-09/service-2.json
botocore/data/codestar-connections/2019-12-01/paginators-1.json
botocore/data/codestar-connections/2019-12-01/service-2.json
botocore/data/codestar-notifications/2019-10-15/paginators-1.json
botocore/data/codestar-notifications/2019-10-15/service-2.json
botocore/data/codestar/2017-04-19/paginators-1.json
@ -242,6 +244,8 @@ botocore/data/datasync/2018-11-09/paginators-1.json
botocore/data/datasync/2018-11-09/service-2.json
botocore/data/dax/2017-04-19/paginators-1.json
botocore/data/dax/2017-04-19/service-2.json
botocore/data/detective/2018-10-26/paginators-1.json
botocore/data/detective/2018-10-26/service-2.json
botocore/data/devicefarm/2015-06-23/examples-1.json
botocore/data/devicefarm/2015-06-23/paginators-1.json
botocore/data/devicefarm/2015-06-23/service-2.json
@ -303,6 +307,7 @@ botocore/data/ec2/2016-11-15/waiters-2.json
botocore/data/ecr/2015-09-21/examples-1.json
botocore/data/ecr/2015-09-21/paginators-1.json
botocore/data/ecr/2015-09-21/service-2.json
botocore/data/ecr/2015-09-21/waiters-2.json
botocore/data/ecs/2014-11-13/examples-1.json
botocore/data/ecs/2014-11-13/paginators-1.json
botocore/data/ecs/2014-11-13/service-2.json

View file

@ -1,8 +1,4 @@
jmespath<1.0.0,>=0.7.1
docutils<0.16,>=0.10
python-dateutil<2.8.1,>=2.1
python-dateutil<3.0.0,>=2.1
urllib3<1.26,>=1.20
[:python_version=="2.6"]
ordereddict==1.1
simplejson==3.3.0

View file

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

View file

@ -31,7 +31,7 @@ from botocore.endpoint import EndpointCreator
logger = logging.getLogger(__name__)
VALID_STS_REGIONAL_ENDPOINTS_CONFIG = [
VALID_REGIONAL_ENDPOINTS_CONFIG = [
'legacy',
'regional',
]
@ -83,10 +83,6 @@ class ClientArgsCreator(object):
signing_region = endpoint_config['signing_region']
endpoint_region_name = endpoint_config['region_name']
if signing_region is None and endpoint_region_name is None:
signing_region, endpoint_region_name = \
self._get_default_s3_region(service_name, endpoint_bridge)
config_kwargs['region_name'] = endpoint_region_name
event_emitter = copy.copy(self._event_emitter)
signer = RequestSigner(
@ -147,12 +143,14 @@ class ClientArgsCreator(object):
if client_config.user_agent_extra is not None:
user_agent += ' %s' % client_config.user_agent_extra
s3_config = self.compute_s3_config(client_config)
endpoint_config = self._compute_endpoint_config(
service_name=service_name,
region_name=region_name,
endpoint_url=endpoint_url,
is_secure=is_secure,
endpoint_bridge=endpoint_bridge,
s3_config=s3_config,
)
# Create a new client config to be passed to the client based
# on the final values. We do not want the user to be able
@ -203,18 +201,76 @@ class ClientArgsCreator(object):
return s3_configuration
def _compute_endpoint_config(self, service_name, region_name, endpoint_url,
is_secure, endpoint_bridge):
endpoint_config = endpoint_bridge.resolve(
service_name, region_name, endpoint_url, is_secure)
if self._should_set_global_sts_endpoint(
service_name, region_name, endpoint_url):
self._set_global_sts_endpoint(endpoint_config, is_secure)
is_secure, endpoint_bridge, s3_config):
resolve_endpoint_kwargs = {
'service_name': service_name,
'region_name': region_name,
'endpoint_url': endpoint_url,
'is_secure': is_secure,
'endpoint_bridge': endpoint_bridge,
}
if service_name == 's3':
return self._compute_s3_endpoint_config(
s3_config=s3_config, **resolve_endpoint_kwargs)
if service_name == 'sts':
return self._compute_sts_endpoint_config(**resolve_endpoint_kwargs)
return self._resolve_endpoint(**resolve_endpoint_kwargs)
def _compute_s3_endpoint_config(self, s3_config,
**resolve_endpoint_kwargs):
force_s3_global = self._should_force_s3_global(
resolve_endpoint_kwargs['region_name'], s3_config)
if force_s3_global:
resolve_endpoint_kwargs['region_name'] = None
endpoint_config = self._resolve_endpoint(**resolve_endpoint_kwargs)
self._set_region_if_custom_s3_endpoint(
endpoint_config, resolve_endpoint_kwargs['endpoint_bridge'])
# For backwards compatibility reasons, we want to make sure the
# client.meta.region_name will remain us-east-1 if we forced the
# endpoint to be the global region. Specifically, if this value
# changes to aws-global, it breaks logic where a user is checking
# for us-east-1 as the global endpoint such as in creating buckets.
if force_s3_global and endpoint_config['region_name'] == 'aws-global':
endpoint_config['region_name'] = 'us-east-1'
return endpoint_config
def _should_set_global_sts_endpoint(self, service_name, region_name,
endpoint_url):
if service_name != 'sts':
return False
def _should_force_s3_global(self, region_name, s3_config):
s3_regional_config = 'legacy'
if s3_config and 'us_east_1_regional_endpoint' in s3_config:
s3_regional_config = s3_config['us_east_1_regional_endpoint']
self._validate_s3_regional_config(s3_regional_config)
return (
s3_regional_config == 'legacy' and
region_name in ['us-east-1', None]
)
def _validate_s3_regional_config(self, config_val):
if config_val not in VALID_REGIONAL_ENDPOINTS_CONFIG:
raise botocore.exceptions.\
InvalidS3UsEast1RegionalEndpointConfigError(
s3_us_east_1_regional_endpoint_config=config_val)
def _set_region_if_custom_s3_endpoint(self, endpoint_config,
endpoint_bridge):
# If a user is providing a custom URL, the endpoint resolver will
# refuse to infer a signing region. If we want to default to s3v4,
# we have to account for this.
if endpoint_config['signing_region'] is None \
and endpoint_config['region_name'] is None:
endpoint = endpoint_bridge.resolve('s3')
endpoint_config['signing_region'] = endpoint['signing_region']
endpoint_config['region_name'] = endpoint['region_name']
def _compute_sts_endpoint_config(self, **resolve_endpoint_kwargs):
endpoint_config = self._resolve_endpoint(**resolve_endpoint_kwargs)
if self._should_set_global_sts_endpoint(
resolve_endpoint_kwargs['region_name'],
resolve_endpoint_kwargs['endpoint_url']):
self._set_global_sts_endpoint(
endpoint_config, resolve_endpoint_kwargs['is_secure'])
return endpoint_config
def _should_set_global_sts_endpoint(self, region_name, endpoint_url):
if endpoint_url:
return False
return (
@ -228,7 +284,7 @@ class ClientArgsCreator(object):
if not sts_regional_endpoints_config:
sts_regional_endpoints_config = 'legacy'
if sts_regional_endpoints_config not in \
VALID_STS_REGIONAL_ENDPOINTS_CONFIG:
VALID_REGIONAL_ENDPOINTS_CONFIG:
raise botocore.exceptions.InvalidSTSRegionalEndpointsConfigError(
sts_regional_endpoints_config=sts_regional_endpoints_config)
return sts_regional_endpoints_config
@ -238,14 +294,10 @@ class ClientArgsCreator(object):
endpoint_config['endpoint_url'] = '%s://sts.amazonaws.com' % scheme
endpoint_config['signing_region'] = 'us-east-1'
def _get_default_s3_region(self, service_name, endpoint_bridge):
# If a user is providing a custom URL, the endpoint resolver will
# refuse to infer a signing region. If we want to default to s3v4,
# we have to account for this.
if service_name == 's3':
endpoint = endpoint_bridge.resolve('s3')
return endpoint['signing_region'], endpoint['region_name']
return None, None
def _resolve_endpoint(self, service_name, region_name,
endpoint_url, is_secure, endpoint_bridge):
return endpoint_bridge.resolve(
service_name, region_name, endpoint_url, is_secure)
def _compute_socket_options(self, scoped_config):
# This disables Nagle's algorithm and is the default socket options

View file

@ -15,7 +15,6 @@ import sys
import logging
import functools
import socket
import collections
import urllib3.util
from urllib3.connection import VerifiedHTTPSConnection
@ -26,7 +25,7 @@ from urllib3.connectionpool import HTTPSConnectionPool
import botocore.utils
from botocore.compat import six
from botocore.compat import HTTPHeaders, HTTPResponse, urlunsplit, urlsplit, \
urlencode
urlencode, MutableMapping
from botocore.exceptions import UnseekableStreamError
@ -82,38 +81,6 @@ class AWSConnection(object):
self._expect_header_set = False
self.response_class = self._original_response_cls
def _tunnel(self):
# Works around a bug in py26 which is fixed in later versions of
# python. Bug involves hitting an infinite loop if readline() returns
# nothing as opposed to just ``\r\n``.
# As much as I don't like having if py2: <foo> code blocks, this seems
# the cleanest way to handle this workaround. Fortunately, the
# difference from py26 to py3 is very minimal. We're essentially
# just overriding the while loop.
if sys.version_info[:2] != (2, 6):
return super(AWSConnection, self)._tunnel()
# Otherwise we workaround the issue.
self._set_hostport(self._tunnel_host, self._tunnel_port)
self.send("CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port))
for header, value in self._tunnel_headers.iteritems():
self.send("%s: %s\r\n" % (header, value))
self.send("\r\n")
response = self.response_class(self.sock, strict=self.strict,
method=self._method)
(version, code, message) = response._read_status()
if code != 200:
self.close()
raise socket.error("Tunnel connection failed: %d %s" %
(code, message.strip()))
while True:
line = response.fp.readline()
if not line:
break
if line in (b'\r\n', b'\n', b''):
break
def _send_request(self, method, url, body, headers, *args, **kwargs):
self._response_received = False
if headers.get('Expect', b'') == b'100-continue':
@ -621,7 +588,7 @@ class _HeaderKey(object):
return repr(self._key)
class HeadersDict(collections.MutableMapping):
class HeadersDict(MutableMapping):
"""A case-insenseitive dictionary to represent HTTP headers. """
def __init__(self, *args, **kwargs):
self._dict = {}

View file

@ -194,9 +194,13 @@ class ClientCreator(object):
# Check to see if the region is a region that we know about. If we
# don't know about a region, then we can safely assume it's a new
# region that is sigv4 only, since all new S3 regions only allow sigv4.
# The only exception is aws-global. This is a pseudo-region for the
# global endpoint, we should respect the signature versions it
# supports, which includes v2.
regions = self._endpoint_resolver.get_available_endpoints(
's3', client_meta.partition)
if client_meta.region_name not in regions:
if client_meta.region_name != 'aws-global' and \
client_meta.region_name not in regions:
return
# If it is a region we know about, we want to default to sigv2, so here
@ -331,13 +335,14 @@ class ClientEndpointBridge(object):
def _create_endpoint(self, resolved, service_name, region_name,
endpoint_url, is_secure):
explicit_region = region_name is not None
region_name, signing_region = self._pick_region_values(
resolved, region_name, endpoint_url)
if endpoint_url is None:
if self._is_s3_dualstack_mode(service_name):
endpoint_url = self._create_dualstack_endpoint(
service_name, region_name,
resolved['dnsSuffix'], is_secure)
resolved['dnsSuffix'], is_secure, explicit_region)
else:
# Use the sslCommonName over the hostname for Python 2.6 compat.
hostname = resolved.get('sslCommonName', resolved.get('hostname'))
@ -373,7 +378,12 @@ class ClientEndpointBridge(object):
return False
def _create_dualstack_endpoint(self, service_name, region_name,
dns_suffix, is_secure):
dns_suffix, is_secure, explicit_region):
if not explicit_region and region_name == 'aws-global':
# If the region_name passed was not explicitly set, default to
# us-east-1 instead of the modeled default aws-global. Dualstack
# does not support aws-global
region_name = 'us-east-1'
hostname = '{service}.dualstack.{region}.{dns_suffix}'.format(
service=service_name, region=region_name,
dns_suffix=dns_suffix)

View file

@ -141,42 +141,13 @@ else:
return s
raise ValueError("Expected str or unicode, received %s." % type(s))
try:
from collections import OrderedDict
except ImportError:
# Python2.6 we use the 3rd party back port.
from ordereddict import OrderedDict
from collections import OrderedDict
if sys.version_info[:2] == (2, 6):
import simplejson as json
# In py26, invalid xml parsed by element tree
# will raise a plain old SyntaxError instead of
# a real exception, so we need to abstract this change.
XMLParseError = SyntaxError
# Handle https://github.com/shazow/urllib3/issues/497 for py2.6. In
# python2.6, there is a known issue where sometimes we cannot read the SAN
# from an SSL cert (http://bugs.python.org/issue13034). However, newer
# versions of urllib3 will warn you when there is no SAN. While we could
# just turn off this warning in urllib3 altogether, we _do_ want warnings
# when they're legitimate warnings. This method tries to scope the warning
# filter to be as specific as possible.
def filter_ssl_san_warnings():
warnings.filterwarnings(
'ignore',
message="Certificate has no.*subjectAltName.*",
category=exceptions.SecurityWarning,
module=r".*urllib3\.connection")
else:
import xml.etree.cElementTree
XMLParseError = xml.etree.cElementTree.ParseError
import json
def filter_ssl_san_warnings():
# Noop for non-py26 versions. We will parse the SAN
# appropriately.
pass
import xml.etree.cElementTree
XMLParseError = xml.etree.cElementTree.ParseError
import json
def filter_ssl_warnings():
@ -186,7 +157,6 @@ def filter_ssl_warnings():
message="A true SSLContext object is not available.*",
category=exceptions.InsecurePlatformWarning,
module=r".*urllib3\.util\.ssl_")
filter_ssl_san_warnings()
@classmethod
@ -210,19 +180,9 @@ HTTPHeaders.from_pairs = from_pairs
def copy_kwargs(kwargs):
"""
There is a bug in Python versions < 2.6.5 that prevents you
from passing unicode keyword args (#4978). This function
takes a dictionary of kwargs and returns a copy. If you are
using Python < 2.6.5, it also encodes the keys to avoid this bug.
Oh, and version_info wasn't a namedtuple back then, either!
This used to be a compat shim for 2.6 but is now just an alias.
"""
vi = sys.version_info
if vi[0] == 2 and vi[1] <= 6 and vi[3] < 5:
copy_kwargs = {}
for key in kwargs:
copy_kwargs[key.encode('utf-8')] = kwargs[key]
else:
copy_kwargs = copy.copy(kwargs)
copy_kwargs = copy.copy(kwargs)
return copy_kwargs
@ -230,22 +190,12 @@ def total_seconds(delta):
"""
Returns the total seconds in a ``datetime.timedelta``.
Python 2.6 does not have ``timedelta.total_seconds()``, so we have
to calculate this ourselves. On 2.7 or better, we'll take advantage of the
built-in method.
The math was pulled from the ``datetime`` docs
(http://docs.python.org/2.7/library/datetime.html#datetime.timedelta.total_seconds).
This used to be a compat shim for 2.6 but is now just an alias.
:param delta: The timedelta object
:type delta: ``datetime.timedelta``
"""
if sys.version_info[:2] != (2, 6):
return delta.total_seconds()
day_in_seconds = delta.days * 24 * 3600.0
micro_in_seconds = delta.microseconds / 10.0**6
return day_in_seconds + delta.seconds + micro_in_seconds
return delta.total_seconds()
# Checks to see if md5 is available on this system. A given system might not
@ -377,3 +327,9 @@ def _windows_shell_split(s):
components.append(''.join(buff))
return components
try:
from collections.abc import MutableMapping
except ImportError:
from collections import MutableMapping

View file

@ -91,6 +91,18 @@ class Config(object):
* path -- Addressing style is always by path. Endpoints will be
addressed as such: s3.amazonaws.com/mybucket
* 'us_east_1_regional_endpoint' - Refers to what S3 endpoint to use
when the region is configured to be us-east-1. Values must be a
string that equals:
* regional -- Use the us-east-1.amazonaws.com endpoint if the
client is configured to use the us-east-1 region.
* legacy -- Use the s3.amazonaws.com endpoint if the client is
configured to use the us-east-1 region. This is the default if
the configuration option is not specified.
:type retries: dict
:param retries: A dictionary for retry specific configurations.
Valid keys are:

View file

@ -109,6 +109,11 @@ DEFAULT_S3_CONFIG_VARS = {
['s3_use_arn_region',
('s3', 'use_arn_region')],
'AWS_S3_USE_ARN_REGION', None, utils.ensure_boolean
),
'us_east_1_regional_endpoint': (
['s3_us_east_1_regional_endpoint',
('s3', 'us_east_1_regional_endpoint')],
'AWS_S3_US_EAST_1_REGIONAL_ENDPOINT', None, None
)
}

View file

@ -29,7 +29,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an analyzer with a zone of trust set to your account.</p>",
"documentation":"<p>Creates an analyzer for your account.</p>",
"idempotent":true
},
"CreateArchiveRule":{
@ -49,7 +49,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an archive rule for the specified analyzer.</p>",
"documentation":"<p>Creates an archive rule for the specified analyzer. Archive rules automatically archive findings that meet the criteria you define when you create the rule.</p>",
"idempotent":true
},
"DeleteAnalyzer":{
@ -104,7 +104,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves information about an analyzed resource.</p>"
"documentation":"<p>Retrieves information about a resource that was analyzed.</p>"
},
"GetAnalyzer":{
"name":"GetAnalyzer",
@ -176,7 +176,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list of resources that have been analyzed.</p>"
"documentation":"<p>Retrieves a list of resources of the specified type that have been analyzed by the specified analyzer..</p>"
},
"ListAnalyzers":{
"name":"ListAnalyzers",
@ -263,7 +263,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Starts a scan of the policies applied to the specified resource.</p>"
"documentation":"<p>Immediately starts a scan of the policies applied to the specified resource.</p>"
},
"TagResource":{
"name":"TagResource",
@ -318,7 +318,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates the specified archive rule.</p>",
"documentation":"<p>Updates the criteria and values for the specified archive rule.</p>",
"idempotent":true
},
"UpdateFindings":{
@ -336,7 +336,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates findings with the new values provided in the request.</p>",
"documentation":"<p>Updates the status for the specified findings.</p>",
"idempotent":true
}
},
@ -561,7 +561,7 @@
},
"archiveRules":{
"shape":"InlineArchiveRulesList",
"documentation":"<p>Specifies the archive rules to add for the analyzer.</p>"
"documentation":"<p>Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.</p>"
},
"clientToken":{
"shape":"String",
@ -574,7 +574,7 @@
},
"type":{
"shape":"Type",
"documentation":"<p>The zone of trust for the analyzer. You can create only one analyzer per account per Region.</p>"
"documentation":"<p>The type of analyzer to create. Only ACCOUNT analyzers are supported. You can create only one analyzer per account per Region.</p>"
}
},
"documentation":"<p>Creates an analyzer.</p>"
@ -639,7 +639,7 @@
"documentation":"<p>A \"not equals\" operator to match for the filter used to create the rule.</p>"
}
},
"documentation":"<p>The criteria to use in the filter that defines the rule.</p>"
"documentation":"<p>The criteria to use in the filter that defines the archive rule.</p>"
},
"DeleteAnalyzerRequest":{
"type":"structure",
@ -670,7 +670,7 @@
"members":{
"analyzerName":{
"shape":"Name",
"documentation":"<p>The name of the analyzer that was deleted.</p>",
"documentation":"<p>The name of the analyzer that associated with the archive rule to delete.</p>",
"location":"uri",
"locationName":"analyzerName"
},
@ -961,7 +961,7 @@
"documentation":"<p>A <code>finding</code> object that contains finding details.</p>"
}
},
"documentation":"<p>The resposne to the request.</p>"
"documentation":"<p>The response to the request.</p>"
},
"InlineArchiveRule":{
"type":"structure",
@ -972,14 +972,14 @@
"members":{
"filter":{
"shape":"FilterCriteriaMap",
"documentation":"<p>The criteria for the rule.</p>"
"documentation":"<p>The condition and values for a criterion.</p>"
},
"ruleName":{
"shape":"Name",
"documentation":"<p>The name of the rule.</p>"
}
},
"documentation":"<p>An inline archive rule.</p>"
"documentation":"<p>An criterion statement in an archive rule. Each archive rule may have multiple criteria.</p>"
},
"InlineArchiveRulesList":{
"type":"list",
@ -1061,7 +1061,7 @@
},
"type":{
"shape":"Type",
"documentation":"<p>The type of analyzer, which corresponds to the zone of trust selected when the analyzer was created.</p>",
"documentation":"<p>The type of analyzer.</p>",
"location":"querystring",
"locationName":"type"
}
@ -1163,7 +1163,7 @@
"documentation":"<p>A token used for pagination of results returned.</p>"
}
},
"documentation":"<p>The resposne to the request.</p>"
"documentation":"<p>The response to the request.</p>"
},
"ListTagsForResourceRequest":{
"type":"structure",
@ -1287,7 +1287,7 @@
"documentation":"<p>The sort order, ascending or descending.</p>"
}
},
"documentation":"<p>The sort criteria.</p>"
"documentation":"<p>The criteria used to sort.</p>"
},
"StartResourceScanRequest":{
"type":"structure",
@ -1362,7 +1362,10 @@
},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"Timestamp":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"Token":{"type":"string"},
"Type":{
"type":"string",
@ -1394,7 +1397,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The response tot he request.</p>"
"documentation":"<p>The response to the request.</p>"
},
"UpdateArchiveRuleRequest":{
"type":"structure",
@ -1521,5 +1524,5 @@
"min":1
}
},
"documentation":"<p>AWS IAM Access Analyzer API Reference</p>"
"documentation":"<p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html\">AWS IAM Access Analyzer section of the IAM User Guide</a>.</p> <p>To start using Access Analyzer, you first need to create an analyzer.</p>"
}

View file

@ -1753,6 +1753,7 @@
"OFFLINE"
]
},
"ConnectionStatusUpdatedTime":{"type":"timestamp"},
"Contact":{
"type":"structure",
"members":{
@ -2731,10 +2732,15 @@
"DeviceStatusInfo":{
"shape":"DeviceStatusInfo",
"documentation":"<p>Detailed information about a device's status.</p>"
},
"CreatedTime":{
"shape":"DeviceDataCreatedTime",
"documentation":"<p>The time (in epoch) when the device data was created.</p>"
}
},
"documentation":"<p>Device attributes.</p>"
},
"DeviceDataCreatedTime":{"type":"timestamp"},
"DeviceDataList":{
"type":"list",
"member":{"shape":"DeviceData"}
@ -2873,6 +2879,10 @@
"ConnectionStatus":{
"shape":"ConnectionStatus",
"documentation":"<p>The latest available information about the connection status of a device. </p>"
},
"ConnectionStatusUpdatedTime":{
"shape":"ConnectionStatusUpdatedTime",
"documentation":"<p>The time (in epoch) when the device connection status changed.</p>"
}
},
"documentation":"<p>Detailed information about a device's status.</p>"

View file

@ -259,6 +259,21 @@
],
"documentation":"<p>Lists the auto-grouped, standalone, and custom components of the application.</p>"
},
"ListConfigurationHistory":{
"name":"ListConfigurationHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListConfigurationHistoryRequest"},
"output":{"shape":"ListConfigurationHistoryResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p> Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are: </p> <ul> <li> <p>INFO: creating a new alarm or updating an alarm threshold.</p> </li> <li> <p>WARN: alarm not created due to insufficient data points used to predict thresholds.</p> </li> <li> <p>ERROR: alarm not created due to permission errors or exceeding quotas. </p> </li> </ul>"
},
"ListLogPatternSets":{
"name":"ListLogPatternSets",
"http":{
@ -464,7 +479,7 @@
},
"Remarks":{
"shape":"Remarks",
"documentation":"<p>The issues on the user side that block Application Insights from successfully monitoring an application.</p>"
"documentation":"<p>The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:</p> <ul> <li> <p>“Configuring application, detected 1 Errors, 3 Warnings”</p> </li> <li> <p>“Configuring application, detected 1 Unconfigured Components”</p> </li> </ul>"
}
},
"documentation":"<p>Describes the status of the application.</p>"
@ -487,6 +502,60 @@
"min":1
},
"ComponentName":{"type":"string"},
"ConfigurationEvent":{
"type":"structure",
"members":{
"MonitoredResourceARN":{
"shape":"ConfigurationEventMonitoredResourceARN",
"documentation":"<p> The resource monitored by Application Insights. </p>"
},
"EventStatus":{
"shape":"ConfigurationEventStatus",
"documentation":"<p> The status of the configuration update event. Possible values include INFO, WARN, and ERROR. </p>"
},
"EventResourceType":{
"shape":"ConfigurationEventResourceType",
"documentation":"<p> The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM. </p>"
},
"EventTime":{
"shape":"ConfigurationEventTime",
"documentation":"<p> The timestamp of the event. </p>"
},
"EventDetail":{
"shape":"ConfigurationEventDetail",
"documentation":"<p> The details of the event in plain text. </p>"
},
"EventResourceName":{
"shape":"ConfigurationEventResourceName",
"documentation":"<p> The name of the resource Application Insights attempted to configure. </p>"
}
},
"documentation":"<p> The event information. </p>"
},
"ConfigurationEventDetail":{"type":"string"},
"ConfigurationEventList":{
"type":"list",
"member":{"shape":"ConfigurationEvent"}
},
"ConfigurationEventMonitoredResourceARN":{"type":"string"},
"ConfigurationEventResourceName":{"type":"string"},
"ConfigurationEventResourceType":{
"type":"string",
"enum":[
"CLOUDWATCH_ALARM",
"CLOUDFORMATION",
"SSM_ASSOCIATION"
]
},
"ConfigurationEventStatus":{
"type":"string",
"enum":[
"INFO",
"WARN",
"ERROR"
]
},
"ConfigurationEventTime":{"type":"timestamp"},
"CreateApplicationRequest":{
"type":"structure",
"required":["ResourceGroupName"],
@ -946,6 +1015,48 @@
}
}
},
"ListConfigurationHistoryRequest":{
"type":"structure",
"members":{
"ResourceGroupName":{
"shape":"ResourceGroupName",
"documentation":"<p>Resource group to which the application belongs. </p>"
},
"StartTime":{
"shape":"StartTime",
"documentation":"<p>The start time of the event. </p>"
},
"EndTime":{
"shape":"EndTime",
"documentation":"<p>The end time of the event.</p>"
},
"EventStatus":{
"shape":"ConfigurationEventStatus",
"documentation":"<p>The status of the configuration update event. Possible values include INFO, WARN, and ERROR.</p>"
},
"MaxResults":{
"shape":"MaxEntities",
"documentation":"<p> The maximum number of results returned by <code>ListConfigurationHistory</code> in paginated output. When this parameter is used, <code>ListConfigurationHistory</code> returns only <code>MaxResults</code> 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>ListConfigurationHistory</code> request with the returned <code>NextToken</code> value. If this parameter is not used, then <code>ListConfigurationHistory</code> returns all results. </p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>NextToken</code> value returned from a previous paginated <code>ListConfigurationHistory</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. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListConfigurationHistoryResponse":{
"type":"structure",
"members":{
"EventList":{
"shape":"ConfigurationEventList",
"documentation":"<p> The list of configuration events and their corresponding details. </p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>NextToken</code> value to include in a future <code>ListConfigurationHistory</code> request. When the results of a <code>ListConfigurationHistory</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>"
}
}
},
"ListLogPatternSetsRequest":{
"type":"structure",
"required":["ResourceGroupName"],

View file

@ -760,7 +760,8 @@
"shape":"ApiCacheStatus",
"documentation":"<p>The cache instance status.</p> <ul> <li> <p> <b>AVAILABLE</b>: The instance is available for use.</p> </li> <li> <p> <b>CREATING</b>: The instance is currently creating.</p> </li> <li> <p> <b>DELETING</b>: The instance is currently deleting.</p> </li> <li> <p> <b>MODIFYING</b>: The instance is currently modifying.</p> </li> <li> <p> <b>FAILED</b>: The instance has failed creation.</p> </li> </ul>"
}
}
},
"documentation":"<p>The <code>ApiCache</code> object.</p>"
},
"ApiCacheStatus":{
"type":"string",
@ -1182,6 +1183,10 @@
"additionalAuthenticationProviders":{
"shape":"AdditionalAuthenticationProviders",
"documentation":"<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>"
},
"xrayEnabled":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether to enable X-Ray tracing for the <code>GraphqlApi</code>.</p>"
}
}
},
@ -1688,7 +1693,10 @@
"GetApiCacheResponse":{
"type":"structure",
"members":{
"apiCache":{"shape":"ApiCache"}
"apiCache":{
"shape":"ApiCache",
"documentation":"<p>The <code>ApiCache</code> object.</p>"
}
},
"documentation":"<p>Represents the output of a <code>GetApiCache</code> operation.</p>"
},
@ -1960,6 +1968,10 @@
"additionalAuthenticationProviders":{
"shape":"AdditionalAuthenticationProviders",
"documentation":"<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>"
},
"xrayEnabled":{
"shape":"Boolean",
"documentation":"<p>A flag representing whether X-Ray tracing is enabled for this <code>GraphqlApi</code>.</p>"
}
},
"documentation":"<p>Describes a GraphQL API.</p>"
@ -1999,7 +2011,8 @@
"shape":"String",
"documentation":"<p>The Arn for the Lambda function to use as the Conflict Handler.</p>"
}
}
},
"documentation":"<p>The <code>LambdaConflictHandlerConfig</code> object when configuring LAMBDA as the Conflict Handler.</p>"
},
"LambdaDataSourceConfig":{
"type":"structure",
@ -2942,6 +2955,10 @@
"additionalAuthenticationProviders":{
"shape":"AdditionalAuthenticationProviders",
"documentation":"<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>"
},
"xrayEnabled":{
"shape":"Boolean",
"documentation":"<p>A flag indicating whether to enable X-Ray tracing for the <code>GraphqlApi</code>.</p>"
}
}
},

View file

@ -26,7 +26,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.</p> <p>If you call <code>CreateBackupPlan</code> with a plan that already exists, the existing <code>backupPlanId</code> is returned.</p>",
"documentation":"<p>Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.</p> <p>If you call <code>CreateBackupPlan</code> with a plan that already exists, an <code>AlreadyExistsException</code> is returned.</p>",
"idempotent":true
},
"CreateBackupSelection":{
@ -44,7 +44,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a <code>ListOfTags</code> and selected <code>Resources</code>. </p> <p>For example, consider the following patterns:</p> <ul> <li> <p> <code>Resources: \"arn:aws:ec2:region:account-id:volume/volume-id\"</code> </p> </li> <li> <p> <code>ConditionKey:\"department\"</code> </p> <p> <code>ConditionValue:\"finance\"</code> </p> <p> <code>ConditionType:\"StringEquals\"</code> </p> </li> <li> <p> <code>ConditionKey:\"importance\"</code> </p> <p> <code>ConditionValue:\"critical\"</code> </p> <p> <code>ConditionType:\"StringEquals\"</code> </p> </li> </ul> <p>Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as <code>\"department=finance\"</code>, <code>\"importance=critical\"</code>, in addition to an EBS volume with the specified volume Id.</p> <p>Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.</p>",
"documentation":"<p>Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a <code>ListOfTags</code> and selected <code>Resources</code>. </p> <p>For example, consider the following patterns:</p> <ul> <li> <p> <code>Resources: \"arn:aws:ec2:region:account-id:volume/volume-id\"</code> </p> </li> <li> <p> <code>ConditionKey:\"department\"</code> </p> <p> <code>ConditionValue:\"finance\"</code> </p> <p> <code>ConditionType:\"STRINGEQUALS\"</code> </p> </li> <li> <p> <code>ConditionKey:\"importance\"</code> </p> <p> <code>ConditionValue:\"critical\"</code> </p> <p> <code>ConditionType:\"STRINGEQUALS\"</code> </p> </li> </ul> <p>Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as <code>\"department=finance\"</code>, <code>\"importance=critical\"</code>, in addition to an EBS volume with the specified volume Id.</p> <p>Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.</p>",
"idempotent":true
},
"CreateBackupVault":{
@ -197,6 +197,23 @@
"documentation":"<p>Returns metadata about a backup vault specified by its name.</p>",
"idempotent":true
},
"DescribeCopyJob":{
"name":"DescribeCopyJob",
"http":{
"method":"GET",
"requestUri":"/copy-jobs/{copyJobId}"
},
"input":{"shape":"DescribeCopyJobInput"},
"output":{"shape":"DescribeCopyJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata associated with creating a copy of a resource.</p>",
"idempotent":true
},
"DescribeProtectedResource":{
"name":"DescribeProtectedResource",
"http":{
@ -380,7 +397,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.</p> <p>These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored.</p>",
"documentation":"<p>Returns a set of metadata key-value pairs that were used to create the backup.</p>",
"idempotent":true
},
"GetSupportedResourceTypes":{
@ -405,6 +422,7 @@
"output":{"shape":"ListBackupJobsOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata about your backup jobs.</p>",
@ -494,6 +512,20 @@
"documentation":"<p>Returns a list of recovery point storage containers along with information about them.</p>",
"idempotent":true
},
"ListCopyJobs":{
"name":"ListCopyJobs",
"http":{
"method":"GET",
"requestUri":"/copy-jobs/"
},
"input":{"shape":"ListCopyJobsInput"},
"output":{"shape":"ListCopyJobsOutput"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns metadata about your copy jobs.</p>"
},
"ListProtectedResources":{
"name":"ListProtectedResources",
"http":{
@ -627,6 +659,24 @@
"documentation":"<p>Starts a job to create a one-time backup of the specified resource.</p>",
"idempotent":true
},
"StartCopyJob":{
"name":"StartCopyJob",
"http":{
"method":"PUT",
"requestUri":"/copy-jobs"
},
"input":{"shape":"StartCopyJobInput"},
"output":{"shape":"StartCopyJobOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Starts a job to create a one-time copy of the specified resource.</p>",
"idempotent":true
},
"StartRestoreJob":{
"name":"StartRestoreJob",
"http":{
@ -985,6 +1035,10 @@
"RuleId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a rule that is used to schedule the backup of a selection of resources.</p>"
},
"CopyActions":{
"shape":"CopyActions",
"documentation":"<p>An array of <code>CopyAction</code> objects, which contains the details of the copy operation.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
@ -1023,6 +1077,10 @@
"RecoveryPointTags":{
"shape":"Tags",
"documentation":"<p>To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.</p>"
},
"CopyActions":{
"shape":"CopyActions",
"documentation":"<p>An array of <code>CopyAction</code> objects, which contains the details of the copy operation.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
@ -1056,11 +1114,11 @@
},
"Resources":{
"shape":"ResourceArns",
"documentation":"<p>An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as \"<code>arn:aws:ec2:us-east-1:123456789012:volume/*</code>\" of resources to assign to a backup plan.</p>"
"documentation":"<p>An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.</p>"
},
"ListOfTags":{
"shape":"ListOfTags",
"documentation":"<p>An array of conditions used to specify a set of resources to assign to a backup plan; for example, <code>\"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>.</p>"
"documentation":"<p>An array of conditions used to specify a set of resources to assign to a backup plan; for example, <code>\"STRINGEQUALS\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>.</p>"
}
},
"documentation":"<p>Used to specify a set of resources to a backup plan.</p>"
@ -1108,8 +1166,16 @@
"enum":[
"BACKUP_JOB_STARTED",
"BACKUP_JOB_COMPLETED",
"BACKUP_JOB_SUCCESSFUL",
"BACKUP_JOB_FAILED",
"BACKUP_JOB_EXPIRED",
"RESTORE_JOB_STARTED",
"RESTORE_JOB_COMPLETED",
"RESTORE_JOB_SUCCESSFUL",
"RESTORE_JOB_FAILED",
"COPY_JOB_STARTED",
"COPY_JOB_SUCCESSFUL",
"COPY_JOB_FAILED",
"RECOVERY_POINT_MODIFIED",
"BACKUP_PLAN_CREATED",
"BACKUP_PLAN_MODIFIED"
@ -1182,7 +1248,7 @@
"members":{
"ConditionType":{
"shape":"ConditionType",
"documentation":"<p>An operation, such as <code>StringEquals</code>, that is applied to a key-value pair used to filter resources in a selection.</p>"
"documentation":"<p>An operation, such as <code>STRINGEQUALS</code>, that is applied to a key-value pair used to filter resources in a selection.</p>"
},
"ConditionKey":{
"shape":"ConditionKey",
@ -1193,7 +1259,7 @@
"documentation":"<p>The value in a key-value pair. For example, in <code>\"ec2:ResourceTag/Department\": \"accounting\"</code>, <code>\"accounting\"</code> is the value.</p>"
}
},
"documentation":"<p>Contains an array of triplets made up of a condition type (such as <code>StringEquals</code>), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.</p>"
"documentation":"<p>Contains an array of triplets made up of a condition type (such as <code>STRINGEQUALS</code>), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.</p>"
},
"ConditionKey":{"type":"string"},
"ConditionType":{
@ -1201,6 +1267,94 @@
"enum":["STRINGEQUALS"]
},
"ConditionValue":{"type":"string"},
"CopyAction":{
"type":"structure",
"required":["DestinationBackupVaultArn"],
"members":{
"Lifecycle":{"shape":"Lifecycle"},
"DestinationBackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.</p>"
}
},
"documentation":"<p>The details of the copy operation.</p>"
},
"CopyActions":{
"type":"list",
"member":{"shape":"CopyAction"}
},
"CopyJob":{
"type":"structure",
"members":{
"CopyJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to copy a resource.</p>"
},
"SourceBackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. </p>"
},
"SourceRecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. </p>"
},
"DestinationBackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.</p>"
},
"DestinationRecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. </p>"
},
"ResourceArn":{
"shape":"ARN",
"documentation":"<p>The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. </p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. </p>"
},
"CompletionDate":{
"shape":"timestamp",
"documentation":"<p>The date and time a job to create a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. </p>"
},
"State":{
"shape":"CopyJobState",
"documentation":"<p>The current state of a resource recovery point.</p>"
},
"StatusMessage":{
"shape":"string",
"documentation":"<p>A detailed message explaining the status of the job that to copy a resource.</p>"
},
"BackupSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of a copy job.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.</p>"
},
"CreatedBy":{"shape":"RecoveryPointCreator"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. </p>"
}
},
"documentation":"<p>Contains detailed information about a copy job.</p>"
},
"CopyJobState":{
"type":"string",
"enum":[
"CREATED",
"RUNNING",
"COMPLETED",
"FAILED"
]
},
"CopyJobsList":{
"type":"list",
"member":{"shape":"CopyJob"}
},
"CreateBackupPlanInput":{
"type":"structure",
"required":["BackupPlan"],
@ -1255,7 +1409,7 @@
},
"BackupSelection":{
"shape":"BackupSelection",
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p> <p>It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources.</p>"
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p>"
},
"CreatorRequestId":{
"shape":"string",
@ -1577,6 +1731,27 @@
}
}
},
"DescribeCopyJobInput":{
"type":"structure",
"required":["CopyJobId"],
"members":{
"CopyJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to copy a resource.</p>",
"location":"uri",
"locationName":"copyJobId"
}
}
},
"DescribeCopyJobOutput":{
"type":"structure",
"members":{
"CopyJob":{
"shape":"CopyJob",
"documentation":"<p>Contains detailed information about a copy job.</p>"
}
}
},
"DescribeProtectedResourceInput":{
"type":"structure",
"required":["ResourceArn"],
@ -1903,7 +2078,7 @@
"members":{
"BackupSelection":{
"shape":"BackupSelection",
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p> <p>It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service that the resource belongs to, and an optional array of tags used to identify a set of resources.</p>"
"documentation":"<p>Specifies the body of a request to assign a set of resources to a backup plan.</p>"
},
"SelectionId":{
"shape":"string",
@ -2019,7 +2194,7 @@
},
"RestoreMetadata":{
"shape":"Metadata",
"documentation":"<p>A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point.</p>"
"documentation":"<p>The set of metadata key-value pairs that describes the original configuration of the backed-up resource. These values vary depending on the service that is being restored.</p>"
}
}
},
@ -2028,7 +2203,7 @@
"members":{
"ResourceTypes":{
"shape":"ResourceTypes",
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
}
}
},
@ -2077,10 +2252,10 @@
},
"DeleteAfterDays":{
"shape":"Long",
"documentation":"<p>Specifies the number of days after creation that a recovery point is deleted. Must be greater than <code>MoveToColdStorageAfterDays</code>.</p>"
"documentation":"<p>Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus <code>MoveToColdStorageAfterDays</code>.</p>"
}
},
"documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p>"
"documentation":"<p>Contains an array of <code>Transition</code> objects specifying how long in days before a recovery point transitions to cold storage or is deleted.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p>"
},
"LimitExceededException":{
"type":"structure",
@ -2146,7 +2321,7 @@
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
}
@ -2335,6 +2510,72 @@
}
}
},
"ListCopyJobsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. </p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"ByResourceArn":{
"shape":"ARN",
"documentation":"<p>Returns only copy jobs that match the specified resource Amazon Resource Name (ARN). </p>",
"location":"querystring",
"locationName":"resourceArn"
},
"ByState":{
"shape":"CopyJobState",
"documentation":"<p>Returns only copy jobs that are in the specified state.</p>",
"location":"querystring",
"locationName":"state"
},
"ByCreatedBefore":{
"shape":"timestamp",
"documentation":"<p>Returns only copy jobs that were created before the specified date.</p>",
"location":"querystring",
"locationName":"createdBefore"
},
"ByCreatedAfter":{
"shape":"timestamp",
"documentation":"<p>Returns only copy jobs that were created after the specified date.</p>",
"location":"querystring",
"locationName":"createdAfter"
},
"ByResourceType":{
"shape":"ResourceType",
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
"ByDestinationVaultArn":{
"shape":"string",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. </p>",
"location":"querystring",
"locationName":"destinationVaultArn"
}
}
},
"ListCopyJobsOutput":{
"type":"structure",
"members":{
"CopyJobs":{
"shape":"CopyJobsList",
"documentation":"<p>An array of structures containing metadata about your copy jobs returned in JSON format. </p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. </p>"
}
}
},
"ListOfTags":{
"type":"list",
"member":{"shape":"Condition"}
@ -2549,7 +2790,8 @@
"Metadata":{
"type":"map",
"key":{"shape":"MetadataKey"},
"value":{"shape":"MetadataValue"}
"value":{"shape":"MetadataValue"},
"sensitive":true
},
"MetadataKey":{"type":"string"},
"MetadataValue":{"type":"string"},
@ -2905,7 +3147,7 @@
},
"IdempotencyToken":{
"shape":"string",
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartBackupJob</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>StartBackupJob</code> multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.</p>"
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartBackupJob</code>.</p>"
},
"StartWindowMinutes":{
"shape":"WindowMinutes",
@ -2942,6 +3184,51 @@
}
}
},
"StartCopyJobInput":{
"type":"structure",
"required":[
"RecoveryPointArn",
"SourceBackupVaultName",
"DestinationBackupVaultArn",
"IamRoleArn"
],
"members":{
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. </p>"
},
"SourceBackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. &gt;</p>"
},
"DestinationBackupVaultArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.</p>"
},
"IdempotencyToken":{
"shape":"string",
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartCopyJob</code>.</p>"
},
"Lifecycle":{"shape":"Lifecycle"}
}
},
"StartCopyJobOutput":{
"type":"structure",
"members":{
"CopyJobId":{
"shape":"string",
"documentation":"<p>Uniquely identifies a request to AWS Backup to copy a resource.</p>"
},
"CreationDate":{
"shape":"timestamp",
"documentation":"<p>The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. &gt;</p>"
}
}
},
"StartRestoreJobInput":{
"type":"structure",
"required":[
@ -2956,7 +3243,7 @@
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.</p>"
"documentation":"<p>A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.</p> <p> You can get configuration metadata about a resource at the time it was backed-up by calling <code>GetRecoveryPointRestoreMetadata</code>. However, values in addition to those provided by <code>GetRecoveryPointRestoreMetadata</code> might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.</p> <p>You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:</p> <ul> <li> <p> <code>file-system-id</code>: ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in <code>GetRecoveryPointRestoreMetadata</code>.</p> </li> <li> <p> <code>Encrypted</code>: A Boolean value that, if true, specifies that the file system is encrypted. If <code>KmsKeyId</code> is specified, <code>Encrypted</code> must be set to <code>true</code>.</p> </li> <li> <p> <code>KmsKeyId</code>: Specifies the AWS KMS key that is used to encrypt the restored file system.</p> </li> <li> <p> <code>PerformanceMode</code>: Specifies the throughput mode of the file system.</p> </li> <li> <p> <code>CreationToken</code>: A user-supplied value that ensures the uniqueness (idempotency) of the request.</p> </li> <li> <p> <code>newFileSystem</code>: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.</p> </li> </ul>"
},
"IamRoleArn":{
"shape":"IAMRoleArn",
@ -2964,11 +3251,11 @@
},
"IdempotencyToken":{
"shape":"string",
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartRestoreJob</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>StartRestoreJob</code> multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores. </p>"
"documentation":"<p>A customer chosen string that can be used to distinguish between calls to <code>StartRestoreJob</code>.</p>"
},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>SGW</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
}
}
},

View file

@ -94,7 +94,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Deregisters an AWS Batch job definition.</p>"
"documentation":"<p>Deregisters an AWS Batch job definition. Job definitions will be permanently deleted after 180 days.</p>"
},
"DescribeComputeEnvironments":{
"name":"DescribeComputeEnvironments",
@ -510,7 +510,7 @@
},
"allocationStrategy":{
"shape":"CRAllocationStrategy",
"documentation":"<p>The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a>. If this is not specified, the default is <code>BEST_FIT</code>, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. <code>BEST_FIT_PROGRESSIVE</code> will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. <code>SPOT_CAPACITY_OPTIMIZED</code> is only available for Spot Instance compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.</p>"
"documentation":"<p>The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a>. If this is not specified, the default is <code>BEST_FIT</code>, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with <code>BEST_FIT</code> then the Spot Fleet IAM Role must be specified. <code>BEST_FIT_PROGRESSIVE</code> will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU. <code>SPOT_CAPACITY_OPTIMIZED</code> is only available for Spot Instance compute resources and will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html \">Allocation Strategies</a> in the <i>AWS Batch User Guide</i>.</p>"
},
"minvCpus":{
"shape":"Integer",
@ -562,7 +562,7 @@
},
"spotIamFleetRole":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html\">Amazon EC2 Spot Fleet Role</a> in the <i>AWS Batch User Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment. This role is required if the allocation strategy set to <code>BEST_FIT</code> or if the allocation strategy is not specified. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html\">Amazon EC2 Spot Fleet Role</a> in the <i>AWS Batch User Guide</i>.</p>"
},
"launchTemplate":{
"shape":"LaunchTemplateSpecification",
@ -1239,7 +1239,7 @@
},
"dependsOn":{
"shape":"JobDependencyList",
"documentation":"<p>A list of job names or IDs on which this job depends.</p>"
"documentation":"<p>A list of job IDs on which this job depends.</p>"
},
"jobDefinition":{
"shape":"String",
@ -1775,7 +1775,7 @@
},
"jobDefinition":{
"shape":"String",
"documentation":"<p>The job definition used by this job. This value can be either a <code>name:revision</code> or the Amazon Resource Name (ARN) for the job definition.</p>"
"documentation":"<p>The job definition used by this job. This value can be one of <code>name</code>, <code>name:revision</code>, or the Amazon Resource Name (ARN) for the job definition. If <code>name</code> is specified without a revision then the latest active revision is used.</p>"
},
"parameters":{
"shape":"ParametersMap",

View file

@ -26,7 +26,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Creates a new Cost Category with the requested name and rules.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Creates a new Cost Category with the requested name and rules.</p>"
},
"DeleteCostCategoryDefinition":{
"name":"DeleteCostCategoryDefinition",
@ -40,7 +40,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.</p>"
},
"DescribeCostCategoryDefinition":{
"name":"DescribeCostCategoryDefinition",
@ -54,7 +54,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.</p> <p>You have the option to use <code>EffectiveOn</code> to return a Cost Category that is active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see a Cost Category that is effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.</p> <p>You have the option to use <code>EffectiveOn</code> to return a Cost Category that is active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see a Cost Category that is effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
},
"GetCostAndUsage":{
"name":"GetCostAndUsage",
@ -281,7 +281,7 @@
"errors":[
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN and effective dates of all Cost Categories defined in the account. You have the option to use <code>EffectiveOn</code> to return a list of Cost Categories that were active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see Cost Categories that are effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Returns the name, ARN and effective dates of all Cost Categories defined in the account. You have the option to use <code>EffectiveOn</code> to return a list of Cost Categories that were active on a specific date. If there is no <code>EffectiveOn</code> specified, youll see Cost Categories that are effective on the current date. If Cost Category is still effective, <code>EffectiveEnd</code> is omitted in the response. </p>"
},
"UpdateCostCategoryDefinition":{
"name":"UpdateCostCategoryDefinition",
@ -296,7 +296,7 @@
{"shape":"ServiceQuotaExceededException"},
{"shape":"LimitExceededException"}
],
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current months expenses and future expenses. This wont change categorization for the previous months.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current months expenses and future expenses. This wont change categorization for the previous months.</p>"
}
},
"shapes":{
@ -367,7 +367,7 @@
"documentation":"<p> Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The structure of Cost Categories. This includes detailed metadata and the set of rules for the <code>CostCategory</code> object.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The structure of Cost Categories. This includes detailed metadata and the set of rules for the <code>CostCategory</code> object.</p>"
},
"CostCategoryName":{
"type":"string",
@ -393,7 +393,7 @@
"documentation":"<p> The Cost Category's effective end date.</p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>A reference to a Cost Category containing only enough information to identify the Cost Category.</p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>A reference to a Cost Category containing only enough information to identify the Cost Category.</p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
},
"CostCategoryReferencesList":{
"type":"list",
@ -412,7 +412,7 @@
"documentation":"<p>An <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.</p>"
},
"CostCategoryRuleVersion":{
"type":"string",
@ -441,7 +441,7 @@
"documentation":"<p>The specific value of the Cost Category.</p>"
}
},
"documentation":"<important> <p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The values that are available for Cost Categories.</p>"
"documentation":"<important> <p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> </important> <p>The values that are available for Cost Categories.</p>"
},
"Coverage":{
"type":"structure",
@ -551,7 +551,7 @@
"RuleVersion":{"shape":"CostCategoryRuleVersion"},
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p> Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
"documentation":"<p> <code>CreateCostCategoryDefinition</code> supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
}
}
},
@ -939,7 +939,7 @@
},
"CostCategories":{
"shape":"CostCategoryValues",
"documentation":"<p> <i> <b>Cost Category is in preview release for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> <p>The specific <code>CostCategory</code> used for <code>Expression</code>.</p>"
"documentation":"<p> <i> <b>Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the <a href=\"https://aws.amazon.com/service-terms/\">AWS Service Terms</a> (Section 1.10).</b> </i> </p> <p>The specific <code>CostCategory</code> used for <code>Expression</code>.</p>"
}
},
"documentation":"<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>REGION==us-east-1 OR REGION==us-west-1</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul> <note> <p>For <code>GetRightsizingRecommendation</code> action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to <code>LINKED_ACCOUNT</code>, <code>REGION</code>, or <code>RIGHTSIZING_TYPE</code>.</p> </note>"
@ -1294,7 +1294,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
"documentation":"<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -2817,7 +2817,7 @@
"RuleVersion":{"shape":"CostCategoryRuleVersion"},
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p> Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
"documentation":"<p> <code>UpdateCostCategoryDefinition</code> supports dimensions, Tags, and nested expressions. Currently the only dimensions supported is <code>LINKED_ACCOUNT</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend you create a separate rule instead.</p> <p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. </p>"
}
}
},

View file

@ -73,6 +73,26 @@
],
"documentation":"<p>Associates phone numbers with the specified Amazon Chime Voice Connector group.</p>"
},
"AssociateSigninDelegateGroupsWithAccount":{
"name":"AssociateSigninDelegateGroupsWithAccount",
"http":{
"method":"POST",
"requestUri":"/accounts/{accountId}?operation=associate-signin-delegate-groups",
"responseCode":200
},
"input":{"shape":"AssociateSigninDelegateGroupsWithAccountRequest"},
"output":{"shape":"AssociateSigninDelegateGroupsWithAccountResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Associates the specified sign-in delegate groups with the specified Amazon Chime account.</p>"
},
"BatchCreateAttendee":{
"name":"BatchCreateAttendee",
"http":{
@ -108,6 +128,7 @@
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -151,7 +172,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action. </p> <p>To sign out users without suspending them, use the <a>LogoutUser</a> action.</p>"
"documentation":"<p>Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html\">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>Users suspended from a <code>Team</code> account are disassociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so.</p> <p>Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action. </p> <p>To sign out users without suspending them, use the <a>LogoutUser</a> action.</p>"
},
"BatchUnsuspendUser":{
"name":"BatchUnsuspendUser",
@ -270,7 +291,8 @@
{"shape":"BadRequestException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"}
],
"documentation":"<p>Creates a bot for an Amazon Chime Enterprise account.</p>"
},
@ -330,6 +352,7 @@
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -351,11 +374,33 @@
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"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>"
},
"CreateUser":{
"name":"CreateUser",
"http":{
"method":"POST",
"requestUri":"/accounts/{accountId}/users?operation=create",
"responseCode":201
},
"input":{"shape":"CreateUserRequest"},
"output":{"shape":"CreateUserResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ConflictException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Creates a user under the specified Amazon Chime account.</p>"
},
"CreateVoiceConnector":{
"name":"CreateVoiceConnector",
"http":{
@ -507,6 +552,7 @@
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -525,6 +571,7 @@
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -706,6 +753,26 @@
],
"documentation":"<p>Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.</p>"
},
"DisassociateSigninDelegateGroupsFromAccount":{
"name":"DisassociateSigninDelegateGroupsFromAccount",
"http":{
"method":"POST",
"requestUri":"/accounts/{accountId}?operation=disassociate-signin-delegate-groups",
"responseCode":200
},
"input":{"shape":"DisassociateSigninDelegateGroupsFromAccountRequest"},
"output":{"shape":"DisassociateSigninDelegateGroupsFromAccountResponse"},
"errors":[
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.</p>"
},
"GetAccount":{
"name":"GetAccount",
"http":{
@ -779,7 +846,8 @@
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"},
{"shape":"BadRequestException"}
{"shape":"BadRequestException"},
{"shape":"ThrottledClientException"}
],
"documentation":"<p>Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.</p>"
},
@ -912,10 +980,11 @@
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Retrieves room details, such as name.</p>"
"documentation":"<p>Retrieves room details, such as the room name.</p>"
},
"GetUser":{
"name":"GetUser",
@ -1171,7 +1240,8 @@
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"}
],
"documentation":"<p>Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.</p>"
},
@ -1245,10 +1315,11 @@
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Lists the membership details for the specified room, such as member IDs, member email addresses, and member names.</p>"
"documentation":"<p>Lists the membership details for the specified room, such as the members' IDs, email addresses, and names.</p>"
},
"ListRooms":{
"name":"ListRooms",
@ -1264,6 +1335,7 @@
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -1502,7 +1574,8 @@
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"}
],
"documentation":"<p>Regenerates the security token for a bot.</p>"
},
@ -1622,7 +1695,8 @@
{"shape":"ForbiddenException"},
{"shape":"BadRequestException"},
{"shape":"UnauthorizedClientException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"ThrottledClientException"}
],
"documentation":"<p>Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.</p>"
},
@ -1696,6 +1770,7 @@
{"shape":"ForbiddenException"},
{"shape":"NotFoundException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
@ -1715,10 +1790,11 @@
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ThrottledClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Updates room membership details, such as member role. The member role designates whether the member is a chat room administrator or a general chat room member. Member role can only be updated for user IDs.</p>"
"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>"
},
"UpdateUser":{
"name":"UpdateUser",
@ -1847,6 +1923,10 @@
"SupportedLicenses":{
"shape":"LicenseList",
"documentation":"<p>Supported licenses for the Amazon Chime account.</p>"
},
"SigninDelegateGroups":{
"shape":"SigninDelegateGroupList",
"documentation":"<p>The sign-in delegate groups associated with the account.</p>"
}
},
"documentation":"<p>The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.</p>"
@ -1884,6 +1964,20 @@
"EnterpriseOIDC"
]
},
"AlexaForBusinessMetadata":{
"type":"structure",
"members":{
"IsAlexaForBusinessEnabled":{
"shape":"Boolean",
"documentation":"<p>Starts or stops Alexa for Business.</p>"
},
"AlexaForBusinessRoomArn":{
"shape":"SensitiveString",
"documentation":"<p>The ARN of the room resource.</p>"
}
},
"documentation":"<p>The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.</p>"
},
"Arn":{
"type":"string",
"max":1024,
@ -1980,6 +2074,30 @@
}
}
},
"AssociateSigninDelegateGroupsWithAccountRequest":{
"type":"structure",
"required":[
"AccountId",
"SigninDelegateGroups"
],
"members":{
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Chime account ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"SigninDelegateGroups":{
"shape":"SigninDelegateGroupList",
"documentation":"<p>The sign-in delegate groups.</p>"
}
}
},
"AssociateSigninDelegateGroupsWithAccountResponse":{
"type":"structure",
"members":{
}
},
"Attendee":{
"type":"structure",
"members":{
@ -2434,7 +2552,7 @@
},
"MediaRegion":{
"shape":"String",
"documentation":"<p>The Region in which to create the meeting. Available values: <code>us-east-1</code>, <code>us-west-2</code>.</p>"
"documentation":"<p>The Region in which to create the meeting. Available values: <code>ap-northeast-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>.</p>"
},
"NotificationsConfiguration":{
"shape":"MeetingNotificationConfiguration",
@ -2549,6 +2667,36 @@
}
}
},
"CreateUserRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Chime account ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"Username":{
"shape":"String",
"documentation":"<p>The user name.</p>"
},
"Email":{
"shape":"EmailAddress",
"documentation":"<p>The user's email address.</p>"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>"
}
}
},
"CreateUserResponse":{
"type":"structure",
"members":{
"User":{"shape":"User"}
}
},
"CreateVoiceConnectorGroupRequest":{
"type":"structure",
"required":["Name"],
@ -2908,6 +3056,30 @@
}
}
},
"DisassociateSigninDelegateGroupsFromAccountRequest":{
"type":"structure",
"required":[
"AccountId",
"GroupNames"
],
"members":{
"AccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Chime account ID.</p>",
"location":"uri",
"locationName":"accountId"
},
"GroupNames":{
"shape":"NonEmptyStringList",
"documentation":"<p>The sign-in delegate group names.</p>"
}
}
},
"DisassociateSigninDelegateGroupsFromAccountResponse":{
"type":"structure",
"members":{
}
},
"E164PhoneNumber":{
"type":"string",
"pattern":"^\\+?[1-9]\\d{1,14}$",
@ -3495,6 +3667,10 @@
"UserEmailList":{
"shape":"UserEmailList",
"documentation":"<p>The user email addresses to which to send the email invitation.</p>"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>"
}
}
},
@ -3865,6 +4041,12 @@
"location":"querystring",
"locationName":"user-email"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>",
"location":"querystring",
"locationName":"user-type"
},
"MaxResults":{
"shape":"ProfileServiceMaxResults",
"documentation":"<p>The maximum number of results to return in a single call. Defaults to 100.</p>",
@ -4052,7 +4234,7 @@
},
"MediaRegion":{
"shape":"String",
"documentation":"<p>The Region in which to create the meeting. Available values: <code>us-east-1</code>, <code>us-west-2</code>.</p>"
"documentation":"<p>The Region in which to create the meeting. Available values: <code>ap-northeast-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>, <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-west-1</code>, <code>eu-west-2</code>, <code>eu-west-3</code>, <code>sa-east-1</code>, <code>us-east-1</code>, <code>us-east-2</code>, <code>us-west-1</code>, <code>us-west-2</code>.</p>"
}
},
"documentation":"<p>A meeting created using the Amazon Chime SDK.</p>"
@ -4901,6 +5083,20 @@
"exception":true,
"fault":true
},
"SigninDelegateGroup":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The group name.</p>"
}
},
"documentation":"<p>An Active Directory (AD) group whose members are granted permission to act as delegates.</p>"
},
"SigninDelegateGroupList":{
"type":"list",
"member":{"shape":"SigninDelegateGroup"}
},
"StreamingConfiguration":{
"type":"structure",
"required":["DataRetentionInHours"],
@ -5279,6 +5475,14 @@
"LicenseType":{
"shape":"License",
"documentation":"<p>The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.</p>"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>"
},
"AlexaForBusinessMetadata":{
"shape":"AlexaForBusinessMetadata",
"documentation":"<p>The Alexa for Business metadata.</p>"
}
}
},
@ -5293,6 +5497,14 @@
"LicenseType":{
"shape":"License",
"documentation":"<p>The user license type.</p>"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>"
},
"AlexaForBusinessMetadata":{
"shape":"AlexaForBusinessMetadata",
"documentation":"<p>The Alexa for Business metadata.</p>"
}
},
"documentation":"<p>The user ID and user fields to update, used with the <a>BatchUpdateUser</a> action.</p>"
@ -5435,6 +5647,10 @@
"shape":"License",
"documentation":"<p>The license type for the user.</p>"
},
"UserType":{
"shape":"UserType",
"documentation":"<p>The user type.</p>"
},
"UserRegistrationStatus":{
"shape":"RegistrationStatus",
"documentation":"<p>The user registration status.</p>"
@ -5451,6 +5667,10 @@
"shape":"Iso8601Timestamp",
"documentation":"<p>Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.</p>"
},
"AlexaForBusinessMetadata":{
"shape":"AlexaForBusinessMetadata",
"documentation":"<p>The Alexa for Business metadata.</p>"
},
"PersonalPIN":{
"shape":"String",
"documentation":"<p>The user's personal meeting PIN.</p>"
@ -5505,6 +5725,13 @@
},
"documentation":"<p>Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.</p>"
},
"UserType":{
"type":"string",
"enum":[
"PrivateUser",
"SharedDevice"
]
},
"VoiceConnector":{
"type":"structure",
"members":{

View file

@ -923,7 +923,7 @@
},
"ICPRecordalStatus":{
"shape":"ICPRecordalStatus",
"documentation":"<p>The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China. </p> <p>The status values returned are the following:</p> <ul> <li> <p> <b>APPROVED</b> indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.</p> </li> <li> <p> <b>SUSPENDED</b> indicates that the associated CNAME does not have a valid ICP recordal number.</p> </li> <li> <p> <b>PENDING</b> indicates that at least one CNAME associated with the distribution does not have a valid ICP recordal number.</p> </li> </ul>"
"documentation":"<p>The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China. </p> <p>The status values returned are the following:</p> <ul> <li> <p> <b>APPROVED</b> indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.</p> </li> <li> <p> <b>SUSPENDED</b> indicates that the associated CNAME does not have a valid ICP recordal number.</p> </li> <li> <p> <b>PENDING</b> indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the distribution because there was an error in trying to determine the status. You can try again to see if the error is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.</p> </li> </ul>"
}
},
"documentation":"<p>AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.</p> <p>For more information about ICP recordals, see <a href=\"https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html\"> Signup, Accounts, and Credentials</a> in <i>Getting Started with AWS services in China</i>.</p>"
@ -1022,7 +1022,7 @@
},
"ForwardedValues":{
"shape":"ForwardedValues",
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
"documentation":"<p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
@ -1321,11 +1321,11 @@
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.</p>"
"documentation":"<p>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the <code>Items</code> field.</p> <p>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this value must be <code>1</code> or higher.</p>"
},
"Items":{
"shape":"CookieNameList",
"documentation":"<p>A complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior.</p>"
"documentation":"<p>A complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the <code>Quantity</code> field.</p> <p>When you set <code>Forward = whitelist</code> (in the <code>CookiePreferences</code> object), this field must contain at least one item.</p>"
}
},
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\"> Caching Content Based on Request Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
@ -1336,11 +1336,11 @@
"members":{
"Forward":{
"shape":"ItemSelection",
"documentation":"<p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element. </p>"
"documentation":"<p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element.</p>"
},
"WhitelistedNames":{
"shape":"CookieNames",
"documentation":"<p>Required if you specify <code>whitelist</code> for the value of <code>Forward:</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or none for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to all or none and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront\"> CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
"documentation":"<p>Required if you specify <code>whitelist</code> for the value of <code>Forward</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or <code>none</code> for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to <code>all</code> or <code>none</code> and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/xrefaws_service_limits.html#limits_cloudfront\"> CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">Caching Content Based on Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
@ -1685,15 +1685,15 @@
},
"ResponsePagePath":{
"shape":"string",
"documentation":"<p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>. </p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>. If you don't want to specify a value, include an empty element, <code>&lt;ResponsePagePath&gt;</code>, in the XML document.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>"
"documentation":"<p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>. </p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>"
},
"ResponseCode":{
"shape":"string",
"documentation":"<p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>. If you don't want to specify a value, include an empty element, <code>&lt;ResponseCode&gt;</code>, in the XML document.</p>"
"documentation":"<p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>.</p>"
},
"ErrorCachingMinTTL":{
"shape":"long",
"documentation":"<p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>If you don't want to specify a value, include an empty element, <code>&lt;ErrorCachingMinTTL&gt;</code>, in the XML document.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
"documentation":"<p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. </p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
@ -1786,7 +1786,7 @@
},
"ForwardedValues":{
"shape":"ForwardedValues",
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
"documentation":"<p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
@ -2060,7 +2060,7 @@
},
"ViewerCertificate":{
"shape":"ViewerCertificate",
"documentation":"<p>A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.</p>"
"documentation":"<p>A complex type that determines the distributions SSL/TLS configuration for communicating with viewers.</p>"
},
"Restrictions":{
"shape":"Restrictions",
@ -2068,7 +2068,7 @@
},
"WebACLId":{
"shape":"string",
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>"
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>"
},
"HttpVersion":{
"shape":"HttpVersion",
@ -2225,7 +2225,7 @@
},
"ViewerCertificate":{
"shape":"ViewerCertificate",
"documentation":"<p>A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.</p>"
"documentation":"<p>A complex type that determines the distributions SSL/TLS configuration for communicating with viewers.</p>"
},
"Restrictions":{
"shape":"Restrictions",
@ -2630,7 +2630,7 @@
"documentation":"<p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.</p>"
}
},
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
"documentation":"<p>A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.</p>"
},
"GeoRestriction":{
"type":"structure",
@ -3247,7 +3247,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Query string parameters specified in the response body are not valid.</p>",
"documentation":"<p>The query string parameters specified are not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3274,7 +3274,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>A response code specified in the response body is not valid.</p>",
"documentation":"<p>A response code is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3283,7 +3283,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>TTL order specified in the response body is not valid.</p>",
"documentation":"<p>The TTL order specified is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3292,7 +3292,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Tagging specified in the response body is not valid.</p>",
"documentation":"<p>The tagging specified is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3301,7 +3301,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>A viewer certificate specified in the response body is not valid.</p>",
"documentation":"<p>A viewer certificate specified is not valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3310,7 +3310,7 @@
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>A web ACL id specified in the response body is not valid.</p>",
"documentation":"<p>A web ACL ID specified is not valid. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example <code>arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a</code>. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example <code>473e64fd-f30b-4765-81a0-62ad96dd167a</code>.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -5391,36 +5391,36 @@
"members":{
"CloudFrontDefaultCertificate":{
"shape":"boolean",
"documentation":"<p>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>, specify the following value:</p> <ul> <li> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt; </code> </p> </li> </ul>"
"documentation":"<p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, set this field to <code>true</code>.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), set this field to <code>false</code> and specify values for the following fields:</p> <ul> <li> <p> <code>ACMCertificateArn</code> or <code>IAMCertificateId</code> (specify a value for one, not both)</p> </li> <li> <p> <code>MinimumProtocolVersion</code> </p> </li> <li> <p> <code>SSLSupportMethod</code> </p> </li> </ul>"
},
"IAMCertificateId":{
"shape":"string",
"documentation":"<p>If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority:</p> <ul> <li> <p> <code>&lt;IAMCertificateId&gt;<i>IAM certificate ID</i>&lt;IAMCertificateId&gt;</code> where <code> <i>IAM certificate ID</i> </code> is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p>"
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">AWS Identity and Access Management (AWS IAM)</a>, provide the ID of the IAM certificate.</p> <p>If you specify an IAM certificate ID, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </p>"
},
"ACMCertificateArn":{
"shape":"string",
"documentation":"<p>If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate:</p> <ul> <li> <p> <code>&lt;ACMCertificateArn&gt;<i>ARN for ACM SSL/TLS certificate</i>&lt;ACMCertificateArn&gt;</code> where <code> <i>ARN for ACM SSL/TLS certificate</i> </code> is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p>"
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html\">AWS Certificate Manager (ACM)</a>, provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (<code>us-east-1</code>).</p> <p>If you specify an ACM certificate ARN, you must also specify values for <code>MinimumProtocolVerison</code> and <code>SSLSupportMethod</code>. </p>"
},
"SSLSupportMethod":{
"shape":"SSLSupportMethod",
"documentation":"<p>If you specify a value for <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn\">ACMCertificateArn</a> or for <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId\">IAMCertificateId</a>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.</p> <ul> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">Wikipedia entry Server Name Indication</a>. To learn about options to explore if you have users with browsers that don't include SNI support, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html\">Choosing How CloudFront Serves HTTPS Requests</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see <a href=\"http://aws.amazon.com/cloudfront/custom-ssl-domains/\">Custom SSL options for Amazon CloudFront</a> on the AWS marketing site.</p> </li> </ul> <p>Don't specify a value for <code>SSLSupportMethod</code> if you specified <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-https-dedicated-ip-or-sni.html\">Choosing How CloudFront Serves HTTPS Requests</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</p> <ul> <li> <p> <code>sni-only</code> The distribution accepts HTTPS connections from only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a>. This is recommended. Most browsers and clients released after 2010 support SNI.</p> </li> <li> <p> <code>vip</code> The distribution accepts HTTPS connections from all viewers including those that dont support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</p> </li> </ul> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, dont set a value for this field.</p>"
},
"MinimumProtocolVersion":{
"shape":"MinimumProtocolVersion",
"documentation":"<p>Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers</p> </li> <li> <p>The cipher that CloudFront uses to encrypt the content that it returns to viewers</p> </li> </ul> <note> <p>On the CloudFront console, this setting is called <b>Security policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.1_2016</code> unless your users are using browsers or devices that do not support TLSv1.1 or later.</p> <p>When both of the following are true, you must specify <code>TLSv1</code> or later for the security policy: </p> <ul> <li> <p>You're using a custom certificate: you specified a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code> </p> </li> <li> <p>You're using SNI: you specified <code>sni-only</code> for <code>SSLSupportMethod</code> </p> </li> </ul> <p>If you specify <code>true</code> for <code>CloudFrontDefaultCertificate</code>, CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you specify for <code>MinimumProtocolVersion</code>.</p> <p>For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\"> Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</p> </li> <li> <p>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>On the CloudFront console, this setting is called <b>Security Policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.2_2018</code> unless your viewers are using browsers or devices that dont support TLSv1.2.</p> <p>When youre using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </p> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</p>"
},
"Certificate":{
"shape":"string",
"documentation":"<p>This field is no longer used. Use one of the following fields instead:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn\">ACMCertificateArn</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId\">IAMCertificateId</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-CloudFrontDefaultCertificate\">CloudFrontDefaultCertificate</a> </p> </li> </ul>",
"documentation":"<p>This field is deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> <li> <p> <code>CloudFrontDefaultCertificate</code> </p> </li> </ul>",
"deprecated":true
},
"CertificateSource":{
"shape":"CertificateSource",
"documentation":"<p>This field is no longer used. Use one of the following fields instead:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn\">ACMCertificateArn</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId\">IAMCertificateId</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-CloudFrontDefaultCertificate\">CloudFrontDefaultCertificate</a> </p> </li> </ul>",
"documentation":"<p>This field is deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> <li> <p> <code>CloudFrontDefaultCertificate</code> </p> </li> </ul>",
"deprecated":true
}
},
"documentation":"<p>A complex type that specifies the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as <code>example.com</code> or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>Specify only one of the following values: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-ACMCertificateArn\">ACMCertificateArn</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-IAMCertificateId\">IAMCertificateId</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ViewerCertificate.html#cloudfront-Type-ViewerCertificate-CloudFrontDefaultCertificate\">CloudFrontDefaultCertificate</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\"> Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
"documentation":"<p>A complex type that determines the distributions SSL/TLS configuration for communicating with viewers.</p> <p>If the distribution doesnt use <code>Aliases</code> (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>—set <code>CloudFrontDefaultCertificate</code> to <code>true</code> and leave all other fields empty.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:</p> <ul> <li> <p>Which viewers the distribution accepts HTTPS connections from: only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a> (recommended), or all viewers including those that dont support SNI.</p> <ul> <li> <p>To accept HTTPS connections from only viewers that support SNI, set <code>SSLSupportMethod</code> to <code>sni-only</code>. This is recommended. Most browsers and clients released after 2010 support SNI. </p> </li> <li> <p>To accept HTTPS connections from all viewers, including those that dont support SNI, set <code>SSLSupportMethod</code> to <code>vip</code>. This is not recommended, and results in additional monthly charges from CloudFront. </p> </li> </ul> </li> <li> <p>The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for <code>MinimumProtocolVersion</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> <li> <p>The location of the SSL/TLS certificate, <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html\">AWS Certificate Manager (ACM)</a> (recommended) or <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">AWS Identity and Access Management (AWS IAM)</a>. You specify the location by setting a value in one of the following fields (not both):</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> </ul> </li> </ul> <p>All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use <code>ViewerProtocolPolicy</code> in the <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use <code>CustomOriginConfig</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html\">Using HTTPS with CloudFront</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html\"> Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"ViewerProtocolPolicy":{
"type":"string",

View file

@ -23,11 +23,12 @@
"input":{"shape":"CopyBackupToRegionRequest"},
"output":{"shape":"CopyBackupToRegionResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Copy an AWS CloudHSM cluster backup to a different region.</p>"
},
@ -40,11 +41,12 @@
"input":{"shape":"CreateClusterRequest"},
"output":{"shape":"CreateClusterResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Creates a new AWS CloudHSM cluster.</p>"
},
@ -74,13 +76,13 @@
"input":{"shape":"DeleteBackupRequest"},
"output":{"shape":"DeleteBackupResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"}
],
"documentation":"<p>Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see <a>RestoreBackup</a> </p>"
"documentation":"<p>Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see <a>RestoreBackup</a>.</p>"
},
"DeleteCluster":{
"name":"DeleteCluster",
@ -91,11 +93,12 @@
"input":{"shape":"DeleteClusterRequest"},
"output":{"shape":"DeleteClusterResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>.</p>"
},
@ -125,11 +128,12 @@
"input":{"shape":"DescribeBackupsRequest"},
"output":{"shape":"DescribeBackupsResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Gets information about backups of AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to get.</p>"
},
@ -142,10 +146,11 @@
"input":{"shape":"DescribeClustersRequest"},
"output":{"shape":"DescribeClustersResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Gets information about AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more clusters to get.</p>"
},
@ -158,11 +163,11 @@
"input":{"shape":"InitializeClusterRequest"},
"output":{"shape":"InitializeClusterResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"}
],
"documentation":"<p>Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use <a>DescribeClusters</a>.</p>"
},
@ -175,11 +180,12 @@
"input":{"shape":"ListTagsRequest"},
"output":{"shape":"ListTagsResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Gets a list of tags for the specified AWS CloudHSM cluster.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more tags to get.</p>"
},
@ -192,13 +198,13 @@
"input":{"shape":"RestoreBackupRequest"},
"output":{"shape":"RestoreBackupResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"}
],
"documentation":"<p>Restores a specified AWS CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For more information on deleting a backup, see <a>DeleteBackup</a>.</p>"
"documentation":"<p>Restores a specified AWS CloudHSM backup that is in the <code>PENDING_DELETION</code> state. For mor information on deleting a backup, see <a>DeleteBackup</a>.</p>"
},
"TagResource":{
"name":"TagResource",
@ -209,11 +215,12 @@
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.</p>"
},
@ -226,11 +233,12 @@
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"CloudHsmAccessDeniedException"},
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmTagException"}
],
"documentation":"<p>Removes the specified tag or tags from the specified AWS CloudHSM cluster.</p>"
}
@ -256,16 +264,29 @@
"shape":"Timestamp",
"documentation":"<p>The date and time when the backup was created.</p>"
},
"CopyTimestamp":{"shape":"Timestamp"},
"SourceRegion":{"shape":"Region"},
"SourceBackup":{"shape":"BackupId"},
"SourceCluster":{"shape":"ClusterId"},
"CopyTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the backup was copied from a source backup.</p>"
},
"SourceRegion":{
"shape":"Region",
"documentation":"<p>The AWS region that contains the source backup from which the new backup was copied.</p>"
},
"SourceBackup":{
"shape":"BackupId",
"documentation":"<p>The identifier (ID) of the source backup from which the new backup was copied.</p>"
},
"SourceCluster":{
"shape":"ClusterId",
"documentation":"<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied. .</p>"
},
"DeleteTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the backup will be permanently deleted.</p>"
}
},
"TagList":{"shape":"TagList"}
},
"documentation":"<p>Contains information about a backup of an AWS CloudHSM cluster.</p>"
"documentation":"<p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion paramters. A backup that is pending deletion will include the DeleteTimestamp parameter.</p>"
},
"BackupId":{
"type":"string",
@ -361,6 +382,13 @@
"documentation":"<p>The request was rejected because an error occurred.</p>",
"exception":true
},
"CloudHsmTagException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"Cluster":{
"type":"structure",
"members":{
@ -406,7 +434,7 @@
},
"SubnetMapping":{
"shape":"ExternalSubnetMapping",
"documentation":"<p>A map of the cluster's subnets and their corresponding Availability Zones.</p>"
"documentation":"<p>A map from availability zone to the clusters subnet in that availability zone.</p>"
},
"VpcId":{
"shape":"VpcId",
@ -415,7 +443,8 @@
"Certificates":{
"shape":"Certificates",
"documentation":"<p>Contains one or more certificates or a certificate signing request (CSR).</p>"
}
},
"TagList":{"shape":"TagList"}
},
"documentation":"<p>Contains information about an AWS CloudHSM cluster.</p>"
},
@ -455,7 +484,8 @@
"BackupId":{
"shape":"BackupId",
"documentation":"<p>The ID of the backup that will be copied to the destination region. </p>"
}
},
"TagList":{"shape":"TagList"}
}
},
"CopyBackupToRegionResponse":{
@ -485,7 +515,8 @@
"SourceBackupId":{
"shape":"BackupId",
"documentation":"<p>The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use <a>DescribeBackups</a>.</p>"
}
},
"TagList":{"shape":"TagList"}
}
},
"CreateClusterResponse":{
@ -611,7 +642,10 @@
"shape":"Filters",
"documentation":"<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</p> <p>Use the <code>sourceBackupIds</code> filter to return only the backups created from a source backup. The <code>sourceBackupID</code> of a source backup is returned by the <a>CopyBackupToRegion</a> operation.</p> <p>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>states</code> filter to return only backups that match the specified state.</p>"
},
"SortAscending":{"shape":"Boolean"}
"SortAscending":{
"shape":"Boolean",
"documentation":"<p>Designates whether or not to sort the return backups by ascending chronological order of generation.</p>"
}
}
},
"DescribeBackupsResponse":{
@ -660,11 +694,24 @@
"DestinationBackup":{
"type":"structure",
"members":{
"CreateTimestamp":{"shape":"Timestamp"},
"SourceRegion":{"shape":"Region"},
"SourceBackup":{"shape":"BackupId"},
"SourceCluster":{"shape":"ClusterId"}
}
"CreateTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The date and time when both the source backup was created.</p>"
},
"SourceRegion":{
"shape":"Region",
"documentation":"<p>The AWS region that contains the source backup from which the new backup was copied.</p>"
},
"SourceBackup":{
"shape":"BackupId",
"documentation":"<p>The identifier (ID) of the source backup from which the new backup was copied.</p>"
},
"SourceCluster":{
"shape":"ClusterId",
"documentation":"<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>"
}
},
"documentation":"<p>Contains information about the backup that will be copied and created by the <a>CopyBackupToRegion</a> operation.</p>"
},
"EniId":{
"type":"string",
@ -767,7 +814,7 @@
},
"TrustAnchor":{
"shape":"Cert",
"documentation":"<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.</p>"
"documentation":"<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.</p>"
}
}
},
@ -793,7 +840,7 @@
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ClusterId",
"shape":"ResourceId",
"documentation":"<p>The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use <a>DescribeClusters</a>.</p>"
},
"NextToken":{
@ -839,6 +886,10 @@
"type":"string",
"pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d"
},
"ResourceId":{
"type":"string",
"pattern":"(?:cluster|backup)-[2-7a-zA-Z]{11,16}"
},
"RestoreBackupRequest":{
"type":"structure",
"required":["BackupId"],
@ -860,7 +911,7 @@
},
"SecurityGroup":{
"type":"string",
"pattern":"sg-[0-9a-fA-F]"
"pattern":"sg-[0-9a-fA-F]{8,17}"
},
"StateMessage":{
"type":"string",
@ -926,7 +977,7 @@
],
"members":{
"ResourceId":{
"shape":"ClusterId",
"shape":"ResourceId",
"documentation":"<p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use <a>DescribeClusters</a>.</p>"
},
"TagList":{
@ -955,7 +1006,7 @@
],
"members":{
"ResourceId":{
"shape":"ClusterId",
"shape":"ResourceId",
"documentation":"<p>The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use <a>DescribeClusters</a>.</p>"
},
"TagKeyList":{
@ -975,5 +1026,5 @@
},
"errorMessage":{"type":"string"}
},
"documentation":"<p>For more information about AWS CloudHSM, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a> and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>.</p>"
"documentation":"<p>For more information about AWS CloudHSM, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a> and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>.</p>"
}

View file

@ -568,6 +568,10 @@
"Configuration":{
"shape":"AnomalyDetectorConfiguration",
"documentation":"<p>The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.</p>"
},
"StateValue":{
"shape":"AnomalyDetectorStateValue",
"documentation":"<p>The current status of the anomaly detector's training. The possible values are <code>TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA</code> </p>"
}
},
"documentation":"<p>An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.</p>"
@ -591,6 +595,14 @@
"member":{"shape":"Range"}
},
"AnomalyDetectorMetricTimezone":{"type":"string"},
"AnomalyDetectorStateValue":{
"type":"string",
"enum":[
"PENDING_TRAINING",
"TRAINED_INSUFFICIENT_DATA",
"TRAINED"
]
},
"AnomalyDetectors":{
"type":"list",
"member":{"shape":"AnomalyDetector"}

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

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

View file

@ -0,0 +1,250 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-12-01",
"endpointPrefix":"codestar-connections",
"jsonVersion":"1.0",
"protocol":"json",
"serviceFullName":"AWS CodeStar connections",
"serviceId":"CodeStar connections",
"signatureVersion":"v4",
"signingName":"codestar-connections",
"targetPrefix":"com.amazonaws.codestar.connections.CodeStar_connections_20191201",
"uid":"codestar-connections-2019-12-01"
},
"operations":{
"CreateConnection":{
"name":"CreateConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConnectionInput"},
"output":{"shape":"CreateConnectionOutput"},
"errors":[
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.</p>"
},
"DeleteConnection":{
"name":"DeleteConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConnectionInput"},
"output":{"shape":"DeleteConnectionOutput"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>The connection to be deleted.</p>"
},
"GetConnection":{
"name":"GetConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetConnectionInput"},
"output":{"shape":"GetConnectionOutput"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns the connection ARN and details such as status, owner, and provider type.</p>"
},
"ListConnections":{
"name":"ListConnections",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListConnectionsInput"},
"output":{"shape":"ListConnectionsOutput"},
"documentation":"<p>Lists the connections associated with your account.</p>"
}
},
"shapes":{
"AccountId":{
"type":"string",
"max":12,
"min":12,
"pattern":"[0-9]{12}"
},
"Connection":{
"type":"structure",
"members":{
"ConnectionName":{
"shape":"ConnectionName",
"documentation":"<p>The name of the connection. Connection names must be unique in an AWS user account.</p>"
},
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.</p> <note> <p>The ARN is never reused if the connection is deleted.</p> </note>"
},
"ProviderType":{
"shape":"ProviderType",
"documentation":"<p>The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.</p>"
},
"OwnerAccountId":{
"shape":"AccountId",
"documentation":"<p>The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.</p>"
},
"ConnectionStatus":{
"shape":"ConnectionStatus",
"documentation":"<p>The current status of the connection. </p>"
}
},
"documentation":"<p>The configuration that allows a service such as CodePipeline to connect to a third-party code repository.</p>"
},
"ConnectionArn":{
"type":"string",
"max":256,
"min":0,
"pattern":"arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+"
},
"ConnectionList":{
"type":"list",
"member":{"shape":"Connection"}
},
"ConnectionName":{
"type":"string",
"max":32,
"min":1
},
"ConnectionStatus":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"ERROR"
]
},
"CreateConnectionInput":{
"type":"structure",
"required":[
"ProviderType",
"ConnectionName"
],
"members":{
"ProviderType":{
"shape":"ProviderType",
"documentation":"<p>The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.</p>"
},
"ConnectionName":{
"shape":"ConnectionName",
"documentation":"<p>The name of the connection to be created. The name must be unique in the calling AWS account.</p>"
}
}
},
"CreateConnectionOutput":{
"type":"structure",
"required":["ConnectionArn"],
"members":{
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between AWS services.</p> <note> <p>The ARN is never reused if the connection is deleted.</p> </note>"
}
}
},
"DeleteConnectionInput":{
"type":"structure",
"required":["ConnectionArn"],
"members":{
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the connection to be deleted.</p> <note> <p>The ARN is never reused if the connection is deleted.</p> </note>"
}
}
},
"DeleteConnectionOutput":{
"type":"structure",
"members":{
}
},
"ErrorMessage":{
"type":"string",
"max":600
},
"GetConnectionInput":{
"type":"structure",
"required":["ConnectionArn"],
"members":{
"ConnectionArn":{
"shape":"ConnectionArn",
"documentation":"<p>The Amazon Resource Name (ARN) of a connection.</p>"
}
}
},
"GetConnectionOutput":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"<p>The connection details, such as status, owner, and provider type.</p>"
}
}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Exceeded the maximum limit for connections.</p>",
"exception":true
},
"ListConnectionsInput":{
"type":"structure",
"members":{
"ProviderTypeFilter":{
"shape":"ProviderType",
"documentation":"<p>Filters the list of connections to those associated with a specified provider, such as Bitbucket.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token that was returned from the previous <code>ListConnections</code> call, which can be used to return the next set of connections in the list.</p>"
}
}
},
"ListConnectionsOutput":{
"type":"structure",
"members":{
"Connections":{
"shape":"ConnectionList",
"documentation":"<p>A list of connections and the details for each connection, such as status, owner, and provider type.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used in the next <code>ListConnections</code> call. To view all items in the list, continue to call this operation with each subsequent token until no more <code>nextToken</code> values are returned.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":50,
"min":1
},
"NextToken":{
"type":"string",
"max":1024,
"min":1,
"pattern":"[a-zA-Z0-9=\\-\\\\/]+"
},
"ProviderType":{
"type":"string",
"enum":["Bitbucket"]
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Resource not found. Verify the connection resource ARN and try again.</p>",
"exception":true
}
},
"documentation":"<p>This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the Connections API to work with connections and installations.</p> <p> <i>Connections</i> are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.</p> <p>When you create a connection, the console initiates a third-party connection handshake. <i>Installations</i> are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket Cloud app. When you create a connection, you can choose an existing installation or create one.</p> <p>You can work with connections by calling:</p> <ul> <li> <p> <a>CreateConnection</a>, which creates a uniquely named connection that can be referenced by services such as CodePipeline.</p> </li> <li> <p> <a>DeleteConnection</a>, which deletes the specified connection.</p> </li> <li> <p> <a>GetConnection</a>, which returns information about the connection, including the connection status.</p> </li> <li> <p> <a>ListConnections</a>, which lists the connections associated with your account.</p> </li> </ul> <p>For information about how to use AWS CodeStar Connections, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html\">AWS CodePipeline User Guide</a>.</p>"
}

View file

@ -1140,6 +1140,22 @@
"F1Score":{
"shape":"Double",
"documentation":"<p>A measure of how accurate the classifier results are for the test data. It is derived from the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. </p>"
},
"MicroPrecision":{
"shape":"Double",
"documentation":"<p>A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.</p>"
},
"MicroRecall":{
"shape":"Double",
"documentation":"<p>A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.</p>"
},
"MicroF1Score":{
"shape":"Double",
"documentation":"<p>A measure of how accurate the classifier results are for the test data. It is a combination of the <code>Micro Precision</code> and <code>Micro Recall</code> values. The <code>Micro F1Score</code> is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.</p>"
},
"HammingLoss":{
"shape":"Double",
"documentation":"<p>Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.</p>"
}
},
"documentation":"<p>Describes the result metrics for the test data associated with an documentation classifier.</p>"
@ -1189,6 +1205,10 @@
"Classes":{
"shape":"ListOfClasses",
"documentation":"<p>The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time. </p>"
},
"Labels":{
"shape":"ListOfLabels",
"documentation":"<p>The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not multually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time. </p>"
}
}
},
@ -1276,6 +1296,10 @@
"VpcConfig":{
"shape":"VpcConfig",
"documentation":"<p>Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
},
"Mode":{
"shape":"DocumentClassifierMode",
"documentation":"<p>Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).</p>"
}
}
},
@ -1853,10 +1877,21 @@
"S3Uri":{
"shape":"S3Uri",
"documentation":"<p>The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.</p> <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.</p>"
},
"LabelDelimiter":{
"shape":"LabelDelimiter",
"documentation":"<p>Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL.</p>"
}
},
"documentation":"<p>The input properties for training a document classifier. </p> <p>For more information on how the input file is formatted, see <a>how-document-classification-training-data</a>. </p>"
},
"DocumentClassifierMode":{
"type":"string",
"enum":[
"MULTI_CLASS",
"MULTI_LABEL"
]
},
"DocumentClassifierOutputDataConfig":{
"type":"structure",
"members":{
@ -1929,6 +1964,10 @@
"VpcConfig":{
"shape":"VpcConfig",
"documentation":"<p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. </p>"
},
"Mode":{
"shape":"DocumentClassifierMode",
"documentation":"<p>Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.</p>"
}
},
"documentation":"<p>Provides information about a document classifier.</p>"
@ -1937,6 +1976,20 @@
"type":"list",
"member":{"shape":"DocumentClassifierProperties"}
},
"DocumentLabel":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the label.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The confidence score that Amazon Comprehend has this label correctly attributed.</p>"
}
},
"documentation":"<p>Specifies one of the label or labels that categorize the document being analyzed.</p>"
},
"DominantLanguage":{
"type":"structure",
"members":{
@ -2674,6 +2727,12 @@
"documentation":"<p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.</p>",
"exception":true
},
"LabelDelimiter":{
"type":"string",
"max":1,
"min":1,
"pattern":"^[ ~!@#$%^*\\-_+=|\\\\:;\\t>?/]$"
},
"LanguageCode":{
"type":"string",
"enum":[
@ -2937,6 +2996,10 @@
"type":"list",
"member":{"shape":"KeyPhrase"}
},
"ListOfLabels":{
"type":"list",
"member":{"shape":"DocumentLabel"}
},
"ListOfSyntaxTokens":{
"type":"list",
"member":{"shape":"SyntaxToken"}

View file

@ -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. It does not return the <code>Quality</code> or <code>Quantity</code> entities.</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.</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",
@ -102,6 +102,42 @@
],
"documentation":"<p> Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.</p>"
},
"InferICD10CM":{
"name":"InferICD10CM",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"InferICD10CMRequest"},
"output":{"shape":"InferICD10CMResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ServiceUnavailableException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidRequestException"},
{"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>"
},
"InferRxNorm":{
"name":"InferRxNorm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"InferRxNormRequest"},
"output":{"shape":"InferRxNormResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ServiceUnavailableException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidRequestException"},
{"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>"
},
"ListEntitiesDetectionV2Jobs":{
"name":"ListEntitiesDetectionV2Jobs",
"http":{
@ -224,7 +260,7 @@
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p> The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string. </p>"
"documentation":"<p> The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.</p>"
},
"Text":{
"shape":"String",
@ -463,7 +499,7 @@
"members":{
"Text":{
"shape":"BoundedLengthString",
"documentation":"<p> A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters. </p>"
"documentation":"<p> A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.</p>"
}
}
},
@ -517,11 +553,11 @@
},
"Type":{
"shape":"EntitySubType",
"documentation":"<p> Describes the specific type of entity with category of entities. </p>"
"documentation":"<p> Describes the specific type of entity with category of entities.</p>"
},
"Traits":{
"shape":"TraitList",
"documentation":"<p>Contextual information for the entity</p>"
"documentation":"<p>Contextual information for the entity.</p>"
},
"Attributes":{
"shape":"AttributeList",
@ -578,12 +614,227 @@
]
},
"Float":{"type":"float"},
"ICD10CMAttribute":{
"type":"structure",
"members":{
"Type":{
"shape":"ICD10CMAttributeType",
"documentation":"<p>The type of attribute. InferICD10CM detects entities of the type <code>DX_NAME</code>. </p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.</p>"
},
"RelationshipScore":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.</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>"
},
"BeginOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.</p>"
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.</p>"
},
"Text":{
"shape":"String",
"documentation":"<p>The segment of input text which contains the detected attribute.</p>"
},
"Traits":{
"shape":"ICD10CMTraitList",
"documentation":"<p>The contextual information for the attribute. The traits recognized by InferICD10CM are <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and <code>NEGATION</code>.</p>"
}
},
"documentation":"<p>The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: <code>Direction</code>, <code>System, Organ or Site</code>, and <code>Acuity</code>.</p>"
},
"ICD10CMAttributeList":{
"type":"list",
"member":{"shape":"ICD10CMAttribute"}
},
"ICD10CMAttributeType":{
"type":"string",
"enum":[
"ACUITY",
"DIRECTION",
"SYSTEM_ORGAN_SITE",
"QUALITY",
"QUANTITY"
]
},
"ICD10CMConcept":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"documentation":"<p>The long description of the ICD-10-CM code in the ontology.</p>"
},
"Code":{
"shape":"String",
"documentation":"<p>The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM concept.</p>"
}
},
"documentation":"<p> The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.</p>"
},
"ICD10CMConceptList":{
"type":"list",
"member":{"shape":"ICD10CMConcept"}
},
"ICD10CMEntity":{
"type":"structure",
"members":{
"Id":{
"shape":"Integer",
"documentation":"<p>The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.</p>"
},
"Text":{
"shape":"OntologyLinkingBoundedLengthString",
"documentation":"<p>The segment of input text that is matched to the detected entity.</p>"
},
"Category":{
"shape":"ICD10CMEntityCategory",
"documentation":"<p> The category of the entity. InferICD10CM detects entities in the <code>MEDICAL_CONDITION</code> category. </p>"
},
"Type":{
"shape":"ICD10CMEntityType",
"documentation":"<p>Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type <code>DX_NAME</code>.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>"
},
"BeginOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.</p>"
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.</p>"
},
"Attributes":{
"shape":"ICD10CMAttributeList",
"documentation":"<p>The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.</p>"
},
"Traits":{
"shape":"ICD10CMTraitList",
"documentation":"<p>Provides Contextual information for the entity. The traits recognized by InferICD10CM are <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and <code>NEGATION.</code> </p>"
},
"ICD10CMConcepts":{
"shape":"ICD10CMConceptList",
"documentation":"<p>The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.</p>"
}
},
"documentation":"<p>The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned. </p>"
},
"ICD10CMEntityCategory":{
"type":"string",
"enum":["MEDICAL_CONDITION"]
},
"ICD10CMEntityList":{
"type":"list",
"member":{"shape":"ICD10CMEntity"}
},
"ICD10CMEntityType":{
"type":"string",
"enum":["DX_NAME"]
},
"ICD10CMTrait":{
"type":"structure",
"members":{
"Name":{
"shape":"ICD10CMTraitName",
"documentation":"<p>Provides a name or contextual description about the trait.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as a trait.</p>"
}
},
"documentation":"<p>Contextual information for the entity. The traits recognized by InferICD10CM are <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and <code>NEGATION</code>.</p>"
},
"ICD10CMTraitList":{
"type":"list",
"member":{"shape":"ICD10CMTrait"}
},
"ICD10CMTraitName":{
"type":"string",
"enum":[
"NEGATION",
"DIAGNOSIS",
"SIGN",
"SYMPTOM"
]
},
"IamRoleArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
},
"InferICD10CMRequest":{
"type":"structure",
"required":["Text"],
"members":{
"Text":{
"shape":"OntologyLinkingBoundedLengthString",
"documentation":"<p>The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.</p>"
}
}
},
"InferICD10CMResponse":{
"type":"structure",
"required":["Entities"],
"members":{
"Entities":{
"shape":"ICD10CMEntityList",
"documentation":"<p>The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.</p>"
},
"PaginationToken":{
"shape":"String",
"documentation":"<p>If the result of the previous request to <code>InferICD10CM</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of medical condition entities. </p>"
},
"ModelVersion":{
"shape":"String",
"documentation":"<p>The version of the model used to analyze the documents, in the format <i>n</i>.<i>n</i>.<i>n</i> You can use this information to track the model used for a particular batch of documents.</p>"
}
}
},
"InferRxNormRequest":{
"type":"structure",
"required":["Text"],
"members":{
"Text":{
"shape":"OntologyLinkingBoundedLengthString",
"documentation":"<p>The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.</p>"
}
}
},
"InferRxNormResponse":{
"type":"structure",
"required":["Entities"],
"members":{
"Entities":{
"shape":"RxNormEntityList",
"documentation":"<p>The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.</p>"
},
"PaginationToken":{
"shape":"String",
"documentation":"<p>If the result of the previous request to <code>InferRxNorm</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of medication entities.</p>"
},
"ModelVersion":{
"shape":"String",
"documentation":"<p>The version of the model used to analyze the documents, in the format <i>n</i>.<i>n</i>.<i>n</i> You can use this information to track the model used for a particular batch of documents.</p>"
}
}
},
"InputDataConfig":{
"type":"structure",
"required":["S3Bucket"],
@ -730,6 +981,11 @@
"min":1
},
"ModelVersion":{"type":"string"},
"OntologyLinkingBoundedLengthString":{
"type":"string",
"max":10000,
"min":1
},
"OutputDataConfig":{
"type":"structure",
"required":["S3Bucket"],
@ -753,6 +1009,165 @@
"documentation":"<p>The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.</p>",
"exception":true
},
"RxNormAttribute":{
"type":"structure",
"members":{
"Type":{
"shape":"RxNormAttributeType",
"documentation":"<p>The type of attribute. The types of attributes recognized by InferRxNorm are <code>BRAND_NAME</code> and <code>GENERIC_NAME</code>.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.</p>"
},
"RelationshipScore":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.</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>"
},
"BeginOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.</p>"
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.</p>"
},
"Text":{
"shape":"String",
"documentation":"<p>The segment of input text which corresponds to the detected attribute.</p>"
},
"Traits":{
"shape":"RxNormTraitList",
"documentation":"<p>Contextual information for the attribute. InferRxNorm recognizes the trait <code>NEGATION</code> for attributes, i.e. that the patient is not taking a specific dose or form of a medication.</p>"
}
},
"documentation":"<p>The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>, <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>.</p>"
},
"RxNormAttributeList":{
"type":"list",
"member":{"shape":"RxNormAttribute"}
},
"RxNormAttributeType":{
"type":"string",
"enum":[
"DOSAGE",
"DURATION",
"FORM",
"FREQUENCY",
"RATE",
"ROUTE_OR_MODE",
"STRENGTH"
]
},
"RxNormConcept":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"documentation":"<p>The description of the RxNorm concept.</p>"
},
"Code":{
"shape":"String",
"documentation":"<p>RxNorm concept ID, also known as the RxCUI.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported RxNorm concept.</p>"
}
},
"documentation":"<p>The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.</p>"
},
"RxNormConceptList":{
"type":"list",
"member":{"shape":"RxNormConcept"}
},
"RxNormEntity":{
"type":"structure",
"members":{
"Id":{
"shape":"Integer",
"documentation":"<p>The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.</p>"
},
"Text":{
"shape":"OntologyLinkingBoundedLengthString",
"documentation":"<p>The segment of input text extracted from which the entity was detected.</p>"
},
"Category":{
"shape":"RxNormEntityCategory",
"documentation":"<p>The category of the entity. The recognized categories are <code>GENERIC</code> or <code>BRAND_NAME</code>.</p>"
},
"Type":{
"shape":"RxNormEntityType",
"documentation":"<p> Describes the specific type of entity. For InferRxNorm, the recognized entity type is <code>MEDICATION</code>.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.</p>"
},
"BeginOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.</p>"
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p>The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.</p>"
},
"Attributes":{
"shape":"RxNormAttributeList",
"documentation":"<p>The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>, <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>, and <code>STRENGTH</code>.</p>"
},
"Traits":{
"shape":"RxNormTraitList",
"documentation":"<p> Contextual information for the entity.</p>"
},
"RxNormConcepts":{
"shape":"RxNormConceptList",
"documentation":"<p> The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.</p>"
}
},
"documentation":"<p>The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned. </p>"
},
"RxNormEntityCategory":{
"type":"string",
"enum":["MEDICATION"]
},
"RxNormEntityList":{
"type":"list",
"member":{"shape":"RxNormEntity"}
},
"RxNormEntityType":{
"type":"string",
"enum":[
"BRAND_NAME",
"GENERIC_NAME"
]
},
"RxNormTrait":{
"type":"structure",
"members":{
"Name":{
"shape":"RxNormTraitName",
"documentation":"<p>Provides a name or contextual description about the trait.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.</p>"
}
},
"documentation":"<p>The contextual information for the entity. InferRxNorm recognizes the trait <code>NEGATION</code>, which is any indication that the patient is not taking a medication. </p>"
},
"RxNormTraitList":{
"type":"list",
"member":{"shape":"RxNormTrait"}
},
"RxNormTraitName":{
"type":"string",
"enum":["NEGATION"]
},
"S3Bucket":{
"type":"string",
"max":63,

View file

@ -56,6 +56,20 @@
],
"documentation":"<p>Creates an endpoint for an Amazon EFS file system.</p>"
},
"CreateLocationFsxWindows":{
"name":"CreateLocationFsxWindows",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateLocationFsxWindowsRequest"},
"output":{"shape":"CreateLocationFsxWindowsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Creates an endpoint for an Amazon FSx for Windows file system.</p>"
},
"CreateLocationNfs":{
"name":"CreateLocationNfs",
"http":{
@ -182,6 +196,20 @@
],
"documentation":"<p>Returns metadata, such as the path information about an Amazon EFS location.</p>"
},
"DescribeLocationFsxWindows":{
"name":"DescribeLocationFsxWindows",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLocationFsxWindowsRequest"},
"output":{"shape":"DescribeLocationFsxWindowsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Returns metadata, such as the path information about an Amazon FSx for Windows location.</p>"
},
"DescribeLocationNfs":{
"name":"DescribeLocationNfs",
"http":{
@ -515,7 +543,7 @@
],
"members":{
"Subdirectory":{
"shape":"Subdirectory",
"shape":"EfsSubdirectory",
"documentation":"<p>A subdirectory in the locations path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.</p> <note> <p> <code>Subdirectory</code> must be specified with forward slashes. For example <code>/path/to/folder</code>.</p> </note>"
},
"EfsFilesystemArn":{
@ -543,6 +571,54 @@
},
"documentation":"<p>CreateLocationEfs</p>"
},
"CreateLocationFsxWindowsRequest":{
"type":"structure",
"required":[
"FsxFilesystemArn",
"SecurityGroupArns",
"User",
"Password"
],
"members":{
"Subdirectory":{
"shape":"FsxWindowsSubdirectory",
"documentation":"<p>A subdirectory in the locations path. This subdirectory in the Amazon FSx for Windows file system is used to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.</p>"
},
"FsxFilesystemArn":{
"shape":"FsxFilesystemArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the FSx for Windows file system.</p>"
},
"SecurityGroupArns":{
"shape":"Ec2SecurityGroupArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the FSx for Windows server belongs to.</p>"
},
"Password":{
"shape":"SmbPassword",
"documentation":"<p>The password of the user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
}
}
},
"CreateLocationFsxWindowsResponse":{
"type":"structure",
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows file system location that is created.</p>"
}
}
},
"CreateLocationNfsRequest":{
"type":"structure",
"required":[
@ -552,7 +628,7 @@
],
"members":{
"Subdirectory":{
"shape":"NonEmptySubdirectory",
"shape":"NfsSubdirectory",
"documentation":"<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p> <p>To see all the paths exported by your NFS server. run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>"
},
"ServerHostname":{
@ -592,7 +668,7 @@
],
"members":{
"Subdirectory":{
"shape":"Subdirectory",
"shape":"S3Subdirectory",
"documentation":"<p>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.</p>"
},
"S3BucketArn":{
@ -632,7 +708,7 @@
],
"members":{
"Subdirectory":{
"shape":"NonEmptySubdirectory",
"shape":"SmbSubdirectory",
"documentation":"<p>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</p> <note> <p> <code>Subdirectory</code> must be specified with forward slashes. For example <code>/path/to/folder</code>.</p> </note> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.</p>"
},
"ServerHostname":{
@ -851,6 +927,45 @@
},
"documentation":"<p>DescribeLocationEfsResponse</p>"
},
"DescribeLocationFsxWindowsRequest":{
"type":"structure",
"required":["LocationArn"],
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows location to describe.</p>"
}
}
},
"DescribeLocationFsxWindowsResponse":{
"type":"structure",
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon resource Name (ARN) of the FSx for Windows location that was described.</p>"
},
"LocationUri":{
"shape":"LocationUri",
"documentation":"<p>The URL of the FSx for Windows location that was described.</p>"
},
"SecurityGroupArns":{
"shape":"Ec2SecurityGroupArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the for the FSx for Windows file system.</p>"
},
"CreationTime":{
"shape":"Time",
"documentation":"<p>The time that the FSx for Windows location was created.</p>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the FSx for Windows server belongs to.</p>"
}
}
},
"DescribeLocationNfsRequest":{
"type":"structure",
"required":["LocationArn"],
@ -1150,6 +1265,11 @@
"max":128,
"pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$"
},
"EfsSubdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$"
},
"Endpoint":{
"type":"string",
"max":15,
@ -1195,6 +1315,16 @@
"max":409600,
"pattern":"^[^\\x00]+$"
},
"FsxFilesystemArn":{
"type":"string",
"max":128,
"pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$"
},
"FsxWindowsSubdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$"
},
"Gid":{
"type":"string",
"enum":[
@ -1402,14 +1532,22 @@
},
"LocationUri":{
"type":"string",
"max":4355,
"pattern":"^(efs|nfs|s3|smb)://[a-zA-Z0-9.\\-]+$"
"max":4356,
"pattern":"^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-]+$"
},
"LogGroupArn":{
"type":"string",
"max":562,
"pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)$"
},
"LogLevel":{
"type":"string",
"enum":[
"OFF",
"BASIC",
"TRANSFER"
]
},
"MaxResults":{
"type":"integer",
"max":100,
@ -1442,6 +1580,11 @@
},
"documentation":"<p>Represents the mount options that are available for DataSync to access an NFS location.</p>"
},
"NfsSubdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$"
},
"NfsVersion":{
"type":"string",
"enum":[
@ -1451,11 +1594,6 @@
"NFS4_1"
]
},
"NonEmptySubdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]+$"
},
"OnPremConfig":{
"type":"structure",
"required":["AgentArns"],
@ -1513,6 +1651,10 @@
"TaskQueueing":{
"shape":"TaskQueueing",
"documentation":"<p>A value that determines whether tasks should be queued before executing the tasks. If set to <code>ENABLED</code>, the tasks will be queued. The default is <code>ENABLED</code>.</p> <p>If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see <a>queue-task-execution</a>.</p>"
},
"LogLevel":{
"shape":"LogLevel",
"documentation":"<p>A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file. If set to <code>OFF</code>, no logs will be delivered. <code>BASIC</code> will deliver a few logs per transfer operation and <code>TRANSFER</code> will deliver a verbose log that contains logs for every file that is transferred.</p>"
}
},
"documentation":"<p>Represents the options that are available to control the behavior of a <a>StartTaskExecution</a> operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.</p> <p>A task has a set of default options associated with it. If you don't specify an option in <a>StartTaskExecution</a>, the default value is used. You can override the defaults options on each task execution by specifying an overriding <code>Options</code> value to <a>StartTaskExecution</a>.</p>"
@ -1614,6 +1756,11 @@
"DEEP_ARCHIVE"
]
},
"S3Subdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$"
},
"ScheduleExpressionCron":{
"type":"string",
"max":256,
@ -1645,6 +1792,11 @@
"pattern":"^.{0,104}$",
"sensitive":true
},
"SmbSubdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$"
},
"SmbUser":{
"type":"string",
"max":104,
@ -1688,11 +1840,6 @@
},
"documentation":"<p>StartTaskExecutionResponse</p>"
},
"Subdirectory":{
"type":"string",
"max":4096,
"pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\p{Zs}]*$"
},
"TagKey":{
"type":"string",
"max":256,
@ -1753,7 +1900,7 @@
"type":"string",
"max":256,
"min":1,
"pattern":"^[a-zA-Z0-9\\s+=._:/-]+$"
"pattern":"^[a-zA-Z0-9\\s+=._:@/-]+$"
},
"TaggableResourceArn":{
"type":"string",

View file

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

View file

@ -0,0 +1,600 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-10-26",
"endpointPrefix":"api.detective",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon Detective",
"serviceId":"Detective",
"signatureVersion":"v4",
"signingName":"detective",
"uid":"detective-2018-10-26"
},
"operations":{
"AcceptInvitation":{
"name":"AcceptInvitation",
"http":{
"method":"PUT",
"requestUri":"/invitation"
},
"input":{"shape":"AcceptInvitationRequest"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account. </p> <p>The request provides the ARN of behavior graph.</p> <p>The member account status in the graph must be <code>INVITED</code>.</p>"
},
"CreateGraph":{
"name":"CreateGraph",
"http":{
"method":"POST",
"requestUri":"/graph"
},
"output":{"shape":"CreateGraphResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.</p> <p>The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.</p> <p> <code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph.</p> <p>An account can only be the master account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
"http":{
"method":"POST",
"requestUri":"/graph/members"
},
"input":{"shape":"CreateMembersRequest"},
"output":{"shape":"CreateMembersResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph. </p> <p> <code>CreateMembers</code> verifies the accounts and then sends invitations to the verified accounts.</p> <p>The request provides the behavior graph ARN and the list of accounts to invite.</p> <p>The response separates the requested accounts into two lists:</p> <ul> <li> <p>The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.</p> </li> <li> <p>The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.</p> </li> </ul>"
},
"DeleteGraph":{
"name":"DeleteGraph",
"http":{
"method":"POST",
"requestUri":"/graph/removal"
},
"input":{"shape":"DeleteGraphRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.</p> <p> <code>DeleteGraph</code> can only be called by the master account for a behavior graph.</p>"
},
"DeleteMembers":{
"name":"DeleteMembers",
"http":{
"method":"POST",
"requestUri":"/graph/members/removal"
},
"input":{"shape":"DeleteMembersRequest"},
"output":{"shape":"DeleteMembersResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the <code>DeleteGraph</code> API method.</p>"
},
"DisassociateMembership":{
"name":"DisassociateMembership",
"http":{
"method":"POST",
"requestUri":"/membership/removal"
},
"input":{"shape":"DisassociateMembershipRequest"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Removes the member account from the specified behavior graph. This operation can only be called by a member account that has the <code>ENABLED</code> status.</p>"
},
"GetMembers":{
"name":"GetMembers",
"http":{
"method":"POST",
"requestUri":"/graph/members/get"
},
"input":{"shape":"GetMembersRequest"},
"output":{"shape":"GetMembersResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Returns the membership details for specified member accounts for a behavior graph.</p>"
},
"ListGraphs":{
"name":"ListGraphs",
"http":{
"method":"POST",
"requestUri":"/graphs/list"
},
"input":{"shape":"ListGraphsRequest"},
"output":{"shape":"ListGraphsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.</p> <p>Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.</p>"
},
"ListInvitations":{
"name":"ListInvitations",
"http":{
"method":"POST",
"requestUri":"/invitations/list"
},
"input":{"shape":"ListInvitationsRequest"},
"output":{"shape":"ListInvitationsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by a member account.</p> <p>Open invitations are invitations that the member account has not responded to.</p> <p>The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.</p>"
},
"ListMembers":{
"name":"ListMembers",
"http":{
"method":"POST",
"requestUri":"/graph/members/list"
},
"input":{"shape":"ListMembersRequest"},
"output":{"shape":"ListMembersResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.</p>"
},
"RejectInvitation":{
"name":"RejectInvitation",
"http":{
"method":"POST",
"requestUri":"/invitation/removal"
},
"input":{"shape":"RejectInvitationRequest"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by a member account that has the <code>INVITED</code> status.</p>"
}
},
"shapes":{
"AcceptInvitationRequest":{
"type":"structure",
"required":["GraphArn"],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph that the member account is accepting the invitation for.</p> <p>The member account status in the behavior graph must be <code>INVITED</code>.</p>"
}
}
},
"Account":{
"type":"structure",
"required":[
"AccountId",
"EmailAddress"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account identifier of the AWS account.</p>"
},
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>The AWS account root user email address for the AWS account.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>An AWS account that is the master of or a member of a behavior graph.</p>"
},
"AccountId":{
"type":"string",
"max":12,
"min":12,
"pattern":"^[0-9]+$"
},
"AccountIdList":{
"type":"list",
"member":{"shape":"AccountId"},
"max":50,
"min":1
},
"AccountList":{
"type":"list",
"member":{"shape":"Account"},
"max":50,
"min":1
},
"ConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request attempted an invalid action.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CreateGraphResponse":{
"type":"structure",
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the new behavior graph.</p>"
}
}
},
"CreateMembersRequest":{
"type":"structure",
"required":[
"GraphArn",
"Accounts"
],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph to invite the member accounts to contribute their data to.</p>"
},
"Message":{
"shape":"EmailMessage",
"documentation":"<p>Customized message text to include in the invitation email message to the invited member accounts.</p>"
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.</p>"
}
}
},
"CreateMembersResponse":{
"type":"structure",
"members":{
"Members":{
"shape":"MemberDetailList",
"documentation":"<p>The set of member account invitation requests that Detective was able to process. This includes accounts that are being verified, that failed verification, and that passed verification and are being sent an invitation.</p>"
},
"UnprocessedAccounts":{
"shape":"UnprocessedAccountList",
"documentation":"<p>The list of accounts for which Detective was unable to process the invitation request. For each account, the list provides the reason why the request could not be processed. The list includes accounts that are already member accounts in the behavior graph.</p>"
}
}
},
"DeleteGraphRequest":{
"type":"structure",
"required":["GraphArn"],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph to disable.</p>"
}
}
},
"DeleteMembersRequest":{
"type":"structure",
"required":[
"GraphArn",
"AccountIds"
],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph to delete members from.</p>"
},
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of AWS account identifiers for the member accounts to delete from the behavior graph.</p>"
}
}
},
"DeleteMembersResponse":{
"type":"structure",
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior graph.</p>"
},
"UnprocessedAccounts":{
"shape":"UnprocessedAccountList",
"documentation":"<p>The list of member accounts that Detective was not able to delete from the behavior graph. For each member account, provides the reason that the deletion could not be processed.</p>"
}
}
},
"DisassociateMembershipRequest":{
"type":"structure",
"required":["GraphArn"],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph to remove the member account from.</p> <p>The member account's member status in the behavior graph must be <code>ENABLED</code>.</p>"
}
}
},
"EmailAddress":{
"type":"string",
"max":64,
"min":1,
"pattern":"^.+@.+$"
},
"EmailMessage":{
"type":"string",
"max":1000,
"min":1
},
"ErrorMessage":{"type":"string"},
"GetMembersRequest":{
"type":"structure",
"required":[
"GraphArn",
"AccountIds"
],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph for which to request the member details.</p>"
},
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>The list of AWS account identifiers for the member account for which to return member details.</p> <p>You cannot use <code>GetMembers</code> to retrieve information about member accounts that were removed from the behavior graph.</p>"
}
}
},
"GetMembersResponse":{
"type":"structure",
"members":{
"MemberDetails":{
"shape":"MemberDetailList",
"documentation":"<p>The member account details that Detective is returning in response to the request.</p>"
},
"UnprocessedAccounts":{
"shape":"UnprocessedAccountList",
"documentation":"<p>The requested member accounts for which Detective was unable to return member details.</p> <p>For each account, provides the reason why the request could not be processed.</p>"
}
}
},
"Graph":{
"type":"structure",
"members":{
"Arn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the behavior graph was created. The value is in milliseconds since the epoch.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>A behavior graph in Detective.</p>"
},
"GraphArn":{
"type":"string",
"pattern":"^arn:aws[-\\w]{0,10}?:detective:[-\\w]{2,20}?:\\d{12}?:graph:[abcdef\\d]{32}?$"
},
"GraphList":{
"type":"list",
"member":{"shape":"Graph"}
},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request was valid but failed because of a problem with the service.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"ListGraphsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"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>"
},
"MaxResults":{
"shape":"MemberResultsLimit",
"documentation":"<p>The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.</p>"
}
}
},
"ListGraphsResponse":{
"type":"structure",
"members":{
"GraphList":{
"shape":"GraphList",
"documentation":"<p>A list of behavior graphs that the account is a master for.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.</p>"
}
}
},
"ListInvitationsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>For requests to retrieve the next page of results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.</p>"
},
"MaxResults":{
"shape":"MemberResultsLimit",
"documentation":"<p>The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.</p>"
}
}
},
"ListInvitationsResponse":{
"type":"structure",
"members":{
"Invitations":{
"shape":"MemberDetailList",
"documentation":"<p>The list of behavior graphs for which the member account has open or accepted invitations.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If there are more behavior graphs remaining in the results, then this is the pagination token to use to request the next page of behavior graphs.</p>"
}
}
},
"ListMembersRequest":{
"type":"structure",
"required":["GraphArn"],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph for which to retrieve the list of member accounts.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.</p>"
},
"MaxResults":{
"shape":"MemberResultsLimit",
"documentation":"<p>The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.</p>"
}
}
},
"ListMembersResponse":{
"type":"structure",
"members":{
"MemberDetails":{
"shape":"MemberDetailList",
"documentation":"<p>The list of member accounts in the behavior graph.</p> <p>The results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If there are more member accounts remaining in the results, then this is the pagination token to use to request the next page of member accounts.</p>"
}
}
},
"MemberDetail":{
"type":"structure",
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The AWS account identifier for the member account.</p>"
},
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>The AWS account root user email address for the member account.</p>"
},
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph that the member account was invited to.</p>"
},
"MasterId":{
"shape":"AccountId",
"documentation":"<p>The AWS account identifier of the master account for the behavior graph.</p>"
},
"Status":{
"shape":"MemberStatus",
"documentation":"<p>The current membership status of the member account. The status can have one of the following values:</p> <ul> <li> <p> <code>INVITED</code> - Indicates that the member was sent an invitation but has not yet responded.</p> </li> <li> <p> <code>VERIFICATION_IN_PROGRESS</code> - Indicates that Detective is verifying that the account identifier and email address provided for the member account match. If they do match, then Detective sends the invitation. If the email address and account identifier don't match, then the member cannot be added to the behavior graph.</p> </li> <li> <p> <code>VERIFICATION_FAILED</code> - Indicates that the account and email address provided for the member account do not match, and Detective did not send an invitation to the account.</p> </li> <li> <p> <code>ENABLED</code> - Indicates that the member account accepted the invitation to contribute to the behavior graph.</p> </li> </ul> <p>Member accounts that declined an invitation or that were removed from the behavior graph are not included.</p>"
},
"InvitedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that Detective sent the invitation to the member account. The value is in milliseconds since the epoch.</p>"
},
"UpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the member account was last updated. The value is in milliseconds since the epoch.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>Details about a member account that was invited to contribute to a behavior graph.</p>"
},
"MemberDetailList":{
"type":"list",
"member":{"shape":"MemberDetail"}
},
"MemberResultsLimit":{
"type":"integer",
"box":true,
"max":200,
"min":1
},
"MemberStatus":{
"type":"string",
"enum":[
"INVITED",
"VERIFICATION_IN_PROGRESS",
"VERIFICATION_FAILED",
"ENABLED"
]
},
"PaginationToken":{
"type":"string",
"max":1024,
"min":1
},
"RejectInvitationRequest":{
"type":"structure",
"required":["GraphArn"],
"members":{
"GraphArn":{
"shape":"GraphArn",
"documentation":"<p>The ARN of the behavior graph to reject the invitation to.</p> <p>The member account's current member status in the behavior graph must be <code>INVITED</code>.</p>"
}
}
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request refers to a nonexistent resource.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>This request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1000 member accounts.</p>",
"error":{"httpStatusCode":402},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"UnprocessedAccount":{
"type":"structure",
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The AWS account identifier of the member account that was not processed.</p>"
},
"Reason":{
"shape":"UnprocessedReason",
"documentation":"<p>The reason that the member account request could not be processed.</p>"
}
},
"documentation":"<p>Amazon Detective is currently in preview.</p> <p>A member account that was included in a request but for which the request could not be processed.</p>"
},
"UnprocessedAccountList":{
"type":"list",
"member":{"shape":"UnprocessedAccount"}
},
"UnprocessedReason":{"type":"string"},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request parameters are invalid.</p>",
"error":{"httpStatusCode":400},
"exception":true
}
},
"documentation":"<important> <p>Amazon Detective is currently in preview. The Detective API can only be used by accounts that are admitted into the preview.</p> </important> <p>Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>A Detective master account can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> </ul> <p>A member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>"
}

View file

@ -75,7 +75,7 @@
{"shape":"ServiceAccountException"},
{"shape":"TagOperationException"}
],
"documentation":"<p>Creates a new project.</p>"
"documentation":"<p>Creates a project.</p>"
},
"CreateRemoteAccessSession":{
"name":"CreateRemoteAccessSession",
@ -93,6 +93,34 @@
],
"documentation":"<p>Specifies and starts a remote access session.</p>"
},
"CreateTestGridProject":{
"name":"CreateTestGridProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTestGridProjectRequest"},
"output":{"shape":"CreateTestGridProjectResult"},
"errors":[
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates a Selenium testing project. Projects are used to track <a>TestGridSession</a> instances.</p>"
},
"CreateTestGridUrl":{
"name":"CreateTestGridUrl",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTestGridUrlRequest"},
"output":{"shape":"CreateTestGridUrlResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates a signed, short-term URL that can be passed to a Selenium <code>RemoteWebDriver</code> constructor.</p>"
},
"CreateUpload":{
"name":"CreateUpload",
"http":{
@ -186,7 +214,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>"
"documentation":"<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p>"
},
"DeleteRemoteAccessSession":{
"name":"DeleteRemoteAccessSession",
@ -218,7 +246,23 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Deletes the run, given the run ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>"
"documentation":"<p>Deletes the run, given the run ARN.</p> <p> Deleting this resource does not stop an in-progress run.</p>"
},
"DeleteTestGridProject":{
"name":"DeleteTestGridProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTestGridProjectRequest"},
"output":{"shape":"DeleteTestGridProjectResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"CannotDeleteException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p> Deletes a Selenium testing project and all content generated under it. </p> <important> <p>You cannot undo this operation.</p> </important> <note> <p>You cannot delete a project if it has active sessions.</p> </note>"
},
"DeleteUpload":{
"name":"DeleteUpload",
@ -266,7 +310,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.</p>"
"documentation":"<p>Returns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.</p>"
},
"GetDevice":{
"name":"GetDevice",
@ -298,7 +342,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Returns information about a device instance belonging to a private device fleet.</p>"
"documentation":"<p>Returns information about a device instance that belongs to a private device fleet.</p>"
},
"GetDevicePool":{
"name":"GetDevicePool",
@ -395,7 +439,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
},
"GetProject":{
"name":"GetProject",
@ -477,6 +521,36 @@
],
"documentation":"<p>Gets information about a test.</p>"
},
"GetTestGridProject":{
"name":"GetTestGridProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTestGridProjectRequest"},
"output":{"shape":"GetTestGridProjectResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Retrieves information about a Selenium testing project.</p>"
},
"GetTestGridSession":{
"name":"GetTestGridSession",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTestGridSessionRequest"},
"output":{"shape":"GetTestGridSessionResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>A session is an instance of a browser created through a <code>RemoteWebDriver</code> with the URL from <a>CreateTestGridUrlResult$url</a>. You can use the following to look up sessions:</p> <ul> <li> <p>The session ARN (<a>GetTestGridSessionRequest$sessionArn</a>).</p> </li> <li> <p>The project ARN and a session ID (<a>GetTestGridSessionRequest$projectArn</a> and <a>GetTestGridSessionRequest$sessionId</a>).</p> </li> </ul> <p/>"
},
"GetUpload":{
"name":"GetUpload",
"http":{
@ -651,7 +725,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you must be able to invoke this operation.</p>"
},
"ListOfferingTransactions":{
"name":"ListOfferingTransactions",
@ -668,7 +742,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
},
"ListOfferings":{
"name":"ListOfferings",
@ -685,7 +759,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
},
"ListProjects":{
"name":"ListProjects",
@ -776,11 +850,71 @@
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"TagOperationException"}
],
"documentation":"<p>List the tags for an AWS Device Farm resource.</p>"
},
"ListTestGridProjects":{
"name":"ListTestGridProjects",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTestGridProjectsRequest"},
"output":{"shape":"ListTestGridProjectsResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Gets a list of all Selenium testing projects in your account.</p>"
},
"ListTestGridSessionActions":{
"name":"ListTestGridSessionActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTestGridSessionActionsRequest"},
"output":{"shape":"ListTestGridSessionActionsResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a list of the actions taken in a <a>TestGridSession</a>.</p>"
},
"ListTestGridSessionArtifacts":{
"name":"ListTestGridSessionArtifacts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTestGridSessionArtifactsRequest"},
"output":{"shape":"ListTestGridSessionArtifactsResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Retrieves a list of artifacts created during the session.</p>"
},
"ListTestGridSessions":{
"name":"ListTestGridSessions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTestGridSessionsRequest"},
"output":{"shape":"ListTestGridSessionsResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Retrieves a list of sessions for a <a>TestGridProject</a>.</p>"
},
"ListTests":{
"name":"ListTests",
"http":{
@ -811,7 +945,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Gets information about unique problems.</p>"
"documentation":"<p>Gets information about unique problems, such as exceptions or crashes.</p> <p>Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (<code>OutOfBoundsException in MyActivity.java:386</code>), <code>ListUniqueProblems</code> returns a single entry instead of many individual entries for that exception.</p>"
},
"ListUploads":{
"name":"ListUploads",
@ -858,7 +992,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
},
"RenewOffering":{
"name":"RenewOffering",
@ -875,7 +1009,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Explicitly sets the quantity of devices to renew for an offering, starting from the <code>effectiveDate</code> of the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
"documentation":"<p>Explicitly sets the quantity of devices to renew for an offering, starting from the <code>effectiveDate</code> of the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a>.</p>"
},
"ScheduleRun":{
"name":"ScheduleRun",
@ -908,7 +1042,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.</p>"
"documentation":"<p>Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.</p>"
},
"StopRemoteAccessSession":{
"name":"StopRemoteAccessSession",
@ -940,7 +1074,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.</p>"
"documentation":"<p>Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.</p>"
},
"TagResource":{
"name":"TagResource",
@ -951,12 +1085,13 @@
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"TagOperationException"},
{"shape":"TooManyTagsException"},
{"shape":"TagPolicyException"}
],
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.</p>"
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -967,6 +1102,7 @@
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"TagOperationException"}
],
@ -986,7 +1122,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Updates information about an existing private device instance.</p>"
"documentation":"<p>Updates information about a private device instance.</p>"
},
"UpdateDevicePool":{
"name":"UpdateDevicePool",
@ -1034,7 +1170,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Updates the network profile with specific settings.</p>"
"documentation":"<p>Updates the network profile.</p>"
},
"UpdateProject":{
"name":"UpdateProject",
@ -1052,6 +1188,21 @@
],
"documentation":"<p>Modifies the specified project name, given the project ARN and a new name.</p>"
},
"UpdateTestGridProject":{
"name":"UpdateTestGridProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateTestGridProjectRequest"},
"output":{"shape":"UpdateTestGridProjectResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"ArgumentException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Change details of a project.</p>"
},
"UpdateUpload":{
"name":"UpdateUpload",
"http":{
@ -1066,7 +1217,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Update an uploaded test specification (test spec).</p>"
"documentation":"<p>Updates an uploaded test spec.</p>"
},
"UpdateVPCEConfiguration":{
"name":"UpdateVPCEConfiguration",
@ -1082,7 +1233,7 @@
{"shape":"ServiceAccountException"},
{"shape":"InvalidOperationException"}
],
"documentation":"<p>Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
"documentation":"<p>Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
}
},
"shapes":{
@ -1108,7 +1259,7 @@
},
"maxJobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The maximum number of minutes a test run will execute before it times out.</p>"
"documentation":"<p>The maximum number of minutes a test run executes before it times out.</p>"
},
"trialMinutes":{
"shape":"TrialMinutes",
@ -1120,20 +1271,21 @@
},
"defaultJobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The default number of minutes (at the account level) a test run will execute before it times out. The default value is 150 minutes.</p>"
"documentation":"<p>The default number of minutes (at the account level) a test run executes before it times out. The default value is 150 minutes.</p>"
},
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
}
},
"documentation":"<p>A container for account-level settings within AWS Device Farm.</p>"
"documentation":"<p>A container for account-level settings in AWS Device Farm.</p>"
},
"AccountsCleanup":{"type":"boolean"},
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":32
"min":32,
"pattern":"^arn:.+"
},
"AmazonResourceNames":{
"type":"list",
@ -1168,7 +1320,7 @@
},
"type":{
"shape":"ArtifactType",
"documentation":"<p>The artifact's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>UNKNOWN: An unknown type.</p> </li> <li> <p>SCREENSHOT: The screenshot type.</p> </li> <li> <p>DEVICE_LOG: The device log type.</p> </li> <li> <p>MESSAGE_LOG: The message log type.</p> </li> <li> <p>VIDEO_LOG: The video log type.</p> </li> <li> <p>RESULT_LOG: The result log type.</p> </li> <li> <p>SERVICE_LOG: The service log type.</p> </li> <li> <p>WEBKIT_LOG: The web kit log type.</p> </li> <li> <p>INSTRUMENTATION_OUTPUT: The instrumentation type.</p> </li> <li> <p>EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.</p> </li> <li> <p>CALABASH_JSON_OUTPUT: The Calabash JSON output type.</p> </li> <li> <p>CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.</p> </li> <li> <p>CALABASH_STANDARD_OUTPUT: The Calabash standard output type.</p> </li> <li> <p>CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.</p> </li> <li> <p>AUTOMATION_OUTPUT: The automation output type.</p> </li> <li> <p>APPIUM_SERVER_OUTPUT: The Appium server output type.</p> </li> <li> <p>APPIUM_JAVA_OUTPUT: The Appium Java output type.</p> </li> <li> <p>APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.</p> </li> <li> <p>APPIUM_PYTHON_OUTPUT: The Appium Python output type.</p> </li> <li> <p>APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.</p> </li> <li> <p>EXPLORER_EVENT_LOG: The Explorer event log output type.</p> </li> <li> <p>EXPLORER_SUMMARY_LOG: The Explorer summary log output type.</p> </li> <li> <p>APPLICATION_CRASH_REPORT: The application crash report output type.</p> </li> <li> <p>XCTEST_LOG: The Xcode test output type.</p> </li> <li> <p>VIDEO: The Video output type.</p> </li> <li> <p>CUSTOMER_ARTIFACT:The Customer Artifact output type.</p> </li> <li> <p>CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.</p> </li> <li> <p>TESTSPEC_OUTPUT: The Test Spec Output type.</p> </li> </ul>"
"documentation":"<p>The artifact's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>UNKNOWN</p> </li> <li> <p>SCREENSHOT</p> </li> <li> <p>DEVICE_LOG</p> </li> <li> <p>MESSAGE_LOG</p> </li> <li> <p>VIDEO_LOG</p> </li> <li> <p>RESULT_LOG</p> </li> <li> <p>SERVICE_LOG</p> </li> <li> <p>WEBKIT_LOG</p> </li> <li> <p>INSTRUMENTATION_OUTPUT</p> </li> <li> <p>EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.</p> </li> <li> <p>CALABASH_JSON_OUTPUT</p> </li> <li> <p>CALABASH_PRETTY_OUTPUT</p> </li> <li> <p>CALABASH_STANDARD_OUTPUT</p> </li> <li> <p>CALABASH_JAVA_XML_OUTPUT</p> </li> <li> <p>AUTOMATION_OUTPUT</p> </li> <li> <p>APPIUM_SERVER_OUTPUT</p> </li> <li> <p>APPIUM_JAVA_OUTPUT</p> </li> <li> <p>APPIUM_JAVA_XML_OUTPUT</p> </li> <li> <p>APPIUM_PYTHON_OUTPUT</p> </li> <li> <p>APPIUM_PYTHON_XML_OUTPUT</p> </li> <li> <p>EXPLORER_EVENT_LOG</p> </li> <li> <p>EXPLORER_SUMMARY_LOG</p> </li> <li> <p>APPLICATION_CRASH_REPORT</p> </li> <li> <p>XCTEST_LOG</p> </li> <li> <p>VIDEO</p> </li> <li> <p>CUSTOMER_ARTIFACT</p> </li> <li> <p>CUSTOMER_ARTIFACT_LOG</p> </li> <li> <p>TESTSPEC_OUTPUT</p> </li> </ul>"
},
"extension":{
"shape":"String",
@ -1176,7 +1328,7 @@
},
"url":{
"shape":"URL",
"documentation":"<p>The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.</p>"
"documentation":"<p>The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.</p>"
}
},
"documentation":"<p>Represents the output of a test. Examples of artifacts include logs and screenshots.</p>"
@ -1243,14 +1395,22 @@
},
"architecture":{
"shape":"String",
"documentation":"<p>The CPU's architecture, for example x86 or ARM.</p>"
"documentation":"<p>The CPU's architecture (for example, x86 or ARM).</p>"
},
"clock":{
"shape":"Double",
"documentation":"<p>The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.</p>"
}
},
"documentation":"<p>Represents the amount of CPU that an app is using on a physical device.</p> <p>Note that this does not represent system-wide CPU usage.</p>"
"documentation":"<p>Represents the amount of CPU that an app is using on a physical device. Does not represent system-wide CPU usage.</p>"
},
"CannotDeleteException":{
"type":"structure",
"members":{
"message":{"shape":"Message"}
},
"documentation":"<p>The requested object could not be deleted.</p>",
"exception":true
},
"ClientId":{
"type":"string",
@ -1322,7 +1482,7 @@
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
}
},
"documentation":"<p>Represents a request to the create device pool operation.</p>"
@ -1351,15 +1511,15 @@
},
"packageCleanup":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>"
"documentation":"<p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is <code>false</code> for private devices.</p>"
},
"excludeAppPackagesFromCleanup":{
"shape":"PackageIds",
"documentation":"<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
"documentation":"<p>An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.</p> <p>The list of packages is considered only if you set <code>packageCleanup</code> to <code>true</code>.</p>"
},
"rebootAfterUse":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>"
"documentation":"<p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is <code>true</code>.</p>"
}
}
},
@ -1368,7 +1528,7 @@
"members":{
"instanceProfile":{
"shape":"InstanceProfile",
"documentation":"<p>An object containing information about your instance profile.</p>"
"documentation":"<p>An object that contains information about your instance profile.</p>"
}
}
},
@ -1385,7 +1545,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name you wish to specify for the new network profile.</p>"
"documentation":"<p>The name for the new network profile.</p>"
},
"description":{
"shape":"Message",
@ -1393,7 +1553,7 @@
},
"type":{
"shape":"NetworkProfileType",
"documentation":"<p>The type of network profile you wish to create. Valid values are listed below.</p>"
"documentation":"<p>The type of network profile to create. Valid values are listed here.</p>"
},
"uplinkBandwidthBits":{
"shape":"Long",
@ -1448,7 +1608,7 @@
},
"defaultJobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.</p>"
"documentation":"<p>Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.</p>"
}
},
"documentation":"<p>Represents a request to the create project operation.</p>"
@ -1472,7 +1632,7 @@
},
"vpceConfigurationArns":{
"shape":"AmazonResourceNames",
"documentation":"<p>An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.</p>"
"documentation":"<p>An array of ARNs included in the VPC endpoint configuration.</p>"
}
},
"documentation":"<p>Configuration settings for a remote access session, including billing method.</p>"
@ -1490,7 +1650,7 @@
},
"deviceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.</p>"
"documentation":"<p>The ARN of the device for which you want to create a remote access session.</p>"
},
"instanceArn":{
"shape":"AmazonResourceName",
@ -1498,11 +1658,11 @@
},
"sshPublicKey":{
"shape":"SshPublicKey",
"documentation":"<p> <i>Ignored.</i> The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>Ignored. The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"remoteDebugEnabled":{
"shape":"Boolean",
"documentation":"<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"remoteRecordEnabled":{
"shape":"Boolean",
@ -1514,11 +1674,11 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the remote access session that you wish to create.</p>"
"documentation":"<p>The name of the remote access session to create.</p>"
},
"clientId":{
"shape":"ClientId",
"documentation":"<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This identifier is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"configuration":{
"shape":"CreateRemoteAccessSessionConfiguration",
@ -1526,11 +1686,11 @@
},
"interactionMode":{
"shape":"InteractionMode",
"documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You <b>cannot</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You <b>can</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You <b>can</b> run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
"documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
},
"skipAppResign":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information on how Device Farm modifies your uploads during tests, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> </p>"
}
},
"documentation":"<p>Creates and submits a request to start a remote access session.</p>"
@ -1545,6 +1705,59 @@
},
"documentation":"<p>Represents the server response from a request to create a remote access session.</p>"
},
"CreateTestGridProjectRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"ResourceName",
"documentation":"<p>Human-readable name of the Selenium testing project.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>Human-readable description of the project.</p>"
}
}
},
"CreateTestGridProjectResult":{
"type":"structure",
"members":{
"testGridProject":{
"shape":"TestGridProject",
"documentation":"<p>ARN of the Selenium testing project that was created.</p>"
}
}
},
"CreateTestGridUrlRequest":{
"type":"structure",
"required":[
"projectArn",
"expiresInSeconds"
],
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>ARN (from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>) to associate with the short-term URL. </p>"
},
"expiresInSeconds":{
"shape":"TestGridUrlExpiresInSecondsInput",
"documentation":"<p>Lifetime, in seconds, of the URL.</p>"
}
}
},
"CreateTestGridUrlResult":{
"type":"structure",
"members":{
"url":{
"shape":"String",
"documentation":"<p>A signed URL, expiring in <a>CreateTestGridUrlRequest$expiresInSeconds</a> seconds, to be passed to a <code>RemoteWebDriver</code>. </p>"
},
"expires":{
"shape":"DateTime",
"documentation":"<p>The number of seconds the URL from <a>CreateTestGridUrlResult$url</a> stays active.</p>"
}
}
},
"CreateUploadRequest":{
"type":"structure",
"required":[
@ -1559,15 +1772,15 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the <code>.ipa</code> extension. If uploading an Android app, the file name needs to end with the <code>.apk</code> extension. For all others, the file name must end with the <code>.zip</code> file extension.</p>"
"documentation":"<p>The upload's file name. The name should not contain any forward slashes (<code>/</code>). If you are uploading an iOS app, the file name must end with the <code>.ipa</code> extension. If you are uploading an Android app, the file name must end with the <code>.apk</code> extension. For all others, the file name must end with the <code>.zip</code> file extension.</p>"
},
"type":{
"shape":"UploadType",
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An Xcode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP</p> </li> <li> <p>IOS_APP</p> </li> <li> <p>WEB_APP</p> </li> <li> <p>EXTERNAL_DATA</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p> </li> <li> <p>CALABASH_TEST_PACKAGE</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE</p> </li> <li> <p>XCTEST_TEST_PACKAGE</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC</p> </li> <li> <p>XCTEST_UI_TEST_SPEC</p> </li> </ul> <p> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
},
"contentType":{
"shape":"ContentType",
"documentation":"<p>The upload's content type (for example, \"application/octet-stream\").</p>"
"documentation":"<p>The upload's content type (for example, <code>application/octet-stream</code>).</p>"
}
},
"documentation":"<p>Represents a request to the create upload operation.</p>"
@ -1596,7 +1809,7 @@
},
"vpceServiceName":{
"shape":"VPCEServiceName",
"documentation":"<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>"
"documentation":"<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>"
},
"serviceDnsName":{
"shape":"ServiceDnsName",
@ -1604,7 +1817,7 @@
},
"vpceConfigurationDescription":{
"shape":"VPCEConfigurationDescription",
"documentation":"<p>An optional description, providing more details about your VPC endpoint configuration.</p>"
"documentation":"<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
}
},
@ -1613,7 +1826,7 @@
"members":{
"vpceConfiguration":{
"shape":"VPCEConfiguration",
"documentation":"<p>An object containing information about your VPC endpoint configuration.</p>"
"documentation":"<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
},
@ -1626,18 +1839,18 @@
"members":{
"iosPaths":{
"shape":"IosPaths",
"documentation":"<p>Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.</p>"
"documentation":"<p>Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled from.</p>"
},
"androidPaths":{
"shape":"AndroidPaths",
"documentation":"<p>Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.</p>"
"documentation":"<p>Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are pulled from.</p>"
},
"deviceHostPaths":{
"shape":"DeviceHostPaths",
"documentation":"<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.</p>"
"documentation":"<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests are pulled from.</p>"
}
},
"documentation":"<p>A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.</p> <p>Specify <code>deviceHostPaths</code> and optionally specify either <code>iosPaths</code> or <code>androidPaths</code>.</p> <p>For web app tests, you can specify both <code>iosPaths</code> and <code>androidPaths</code>.</p>"
"documentation":"<p>A JSON object that specifies the paths where the artifacts generated by the customer's tests, on the device or in the test environment, are pulled from.</p> <p>Specify <code>deviceHostPaths</code> and optionally specify either <code>iosPaths</code> or <code>androidPaths</code>.</p> <p>For web app tests, you can specify both <code>iosPaths</code> and <code>androidPaths</code>.</p>"
},
"DateTime":{"type":"timestamp"},
"DeleteDevicePoolRequest":{
@ -1646,7 +1859,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.</p>"
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.</p>"
}
},
"documentation":"<p>Represents a request to the delete device pool operation.</p>"
@ -1678,7 +1891,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the network profile you want to delete.</p>"
"documentation":"<p>The ARN of the network profile to delete.</p>"
}
}
},
@ -1693,7 +1906,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.</p>"
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.</p>"
}
},
"documentation":"<p>Represents a request to the delete project operation.</p>"
@ -1727,7 +1940,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) for the run you wish to delete.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the run to delete.</p>"
}
},
"documentation":"<p>Represents a request to the delete run operation.</p>"
@ -1738,13 +1951,28 @@
},
"documentation":"<p>Represents the result of a delete run request.</p>"
},
"DeleteTestGridProjectRequest":{
"type":"structure",
"required":["projectArn"],
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN of the project to delete, from <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>"
}
}
},
"DeleteTestGridProjectResult":{
"type":"structure",
"members":{
}
},
"DeleteUploadRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.</p>"
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.</p>"
}
},
"documentation":"<p>Represents a request to the delete upload operation.</p>"
@ -1795,11 +2023,11 @@
},
"formFactor":{
"shape":"DeviceFormFactor",
"documentation":"<p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE: The phone form factor.</p> </li> <li> <p>TABLET: The tablet form factor.</p> </li> </ul>"
"documentation":"<p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE</p> </li> <li> <p>TABLET</p> </li> </ul>"
},
"platform":{
"shape":"DevicePlatform",
"documentation":"<p>The device's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID: The Android platform.</p> </li> <li> <p>IOS: The iOS platform.</p> </li> </ul>"
"documentation":"<p>The device's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>"
},
"os":{
"shape":"String",
@ -1839,11 +2067,11 @@
},
"remoteDebugEnabled":{
"shape":"Boolean",
"documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"fleetType":{
"shape":"String",
"documentation":"<p>The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.</p>"
"documentation":"<p>The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.</p>"
},
"fleetName":{
"shape":"String",
@ -1851,11 +2079,11 @@
},
"instances":{
"shape":"DeviceInstances",
"documentation":"<p>The instances belonging to this device.</p>"
"documentation":"<p>The instances that belong to this device.</p>"
},
"availability":{
"shape":"DeviceAvailability",
"documentation":"<p>Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.</p>"
"documentation":"<p>Indicates how likely a device is available for a test run. Currently available in the <a>ListDevices</a> and GetDevice API methods.</p>"
}
},
"documentation":"<p>Represents a device type that an app is tested against.</p>"
@ -1887,23 +2115,29 @@
"HIGHLY_AVAILABLE"
]
},
"DeviceFarmArn":{
"type":"string",
"max":1011,
"min":32,
"pattern":"^arn:aws:devicefarm:.+"
},
"DeviceFilter":{
"type":"structure",
"members":{
"attribute":{
"shape":"DeviceFilterAttribute",
"documentation":"<p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version. For example, \"10.3.2\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model. For example, \"iPad 5th Gen\".</p> <p> <i>Supported operators</i>: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer. For example, \"Apple\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p> <i>Ignored.</i>Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> <p> <i>This filter will be ignored, as remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> </dl>"
"documentation":"<p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are ANDROID or IOS.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version (for example, 10.3.2).</p> <p>Supported operators: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model (for example, iPad 5th Gen).</p> <p>Supported operators: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are PHONE or TABLET.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer (for example, Apple).</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> <p>Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>, this filter is ignored.</p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p>Supported operators: <code>CONTAINS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are PUBLIC or PRIVATE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> </dl>"
},
"operator":{
"shape":"RuleOperator",
"documentation":"<p>Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.</p>"
"documentation":"<p>Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.</p>"
},
"values":{
"shape":"DeviceFilterValues",
"documentation":"<p>An array of one or more filter values used in a device filter.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".</p> </li> <li> <p>The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".</p> </li> <li> <p>The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul>"
"documentation":"<p>An array of one or more filter values used in a device filter.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to ANDROID or IOS.</p> </li> <li> <p>The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>The FORM_FACTOR attribute can be set to PHONE or TABLET.</p> </li> <li> <p>The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.</p> </li> </ul>"
}
},
"documentation":"<p>Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the <code>deviceSelectionConfiguration</code> parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p> <p>It is also passed in as the <code>filters</code> parameter to ListDevices. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>"
"documentation":"<p>Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the <code>deviceSelectionConfiguration</code> parameter to <code>ScheduleRun</code>. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p> <p>It is also passed in as the <code>filters</code> parameter to <code>ListDevices</code>. For an example of the JSON request syntax, see <a>ListDevices</a>.</p>"
},
"DeviceFilterAttribute":{
"type":"string",
@ -1950,15 +2184,15 @@
},
"deviceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the device.</p>"
"documentation":"<p>The ARN of the device.</p>"
},
"labels":{
"shape":"InstanceLabels",
"documentation":"<p>An array of strings describing the device instance.</p>"
"documentation":"<p>An array of strings that describe the device instance.</p>"
},
"status":{
"shape":"InstanceStatus",
"documentation":"<p>The status of the device instance. Valid values are listed below.</p>"
"documentation":"<p>The status of the device instance. Valid values are listed here.</p>"
},
"udid":{
"shape":"String",
@ -1966,7 +2200,7 @@
},
"instanceProfile":{
"shape":"InstanceProfile",
"documentation":"<p>A object containing information about the instance profile.</p>"
"documentation":"<p>A object that contains information about the instance profile.</p>"
}
},
"documentation":"<p>Represents the device instance.</p>"
@ -2025,7 +2259,7 @@
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
"documentation":"<p>The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the <code>rules</code> parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.</p> <p>By specifying the maximum number of devices, you can control the costs that you incur by running tests.</p>"
}
},
"documentation":"<p>Represents a collection of device types.</p>"
@ -2035,7 +2269,7 @@
"members":{
"device":{
"shape":"Device",
"documentation":"<p>The device (phone or tablet) that you wish to return information about.</p>"
"documentation":"<p>The device (phone or tablet) to return information about.</p>"
},
"compatible":{
"shape":"Boolean",
@ -2072,14 +2306,14 @@
"members":{
"filters":{
"shape":"DeviceFilters",
"documentation":"<p>Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p> <b>Attribute</b> </p> <p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\". <i>This filter will be ignored, as remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p> <b>Operator</b> </p> <p>The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p> <b>Values</b> </p> <p>An array of one or more filter values.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".</p> </li> <li> <p>The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".</p> </li> <li> <p>The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> </ul>"
"documentation":"<p>Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p> <b>Attribute</b> </p> <p>The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p> </li> <li> <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p> </li> <li> <p>OS_VERSION: The operating system version (for example, 10.3.2).</p> </li> <li> <p>MODEL: The device model (for example, iPad 5th Gen).</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p> </li> <li> <p>MANUFACTURER: The device manufacturer (for example, Apple).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>, this filter is ignored.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p> </li> </ul> </li> <li> <p> <b>Operator</b> </p> <p>The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p> <b>Values</b> </p> <p>An array of one or more filter values.</p> <p class=\"title\"> <b>Operator Values</b> </p> <ul> <li> <p>The IN and NOT_IN operators can take a values array that has more than one element.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> </ul> <p class=\"title\"> <b>Attribute Values</b> </p> <ul> <li> <p>The PLATFORM attribute can be set to ANDROID or IOS.</p> </li> <li> <p>The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>The FORM_FACTOR attribute can be set to PHONE or TABLET.</p> </li> <li> <p>The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.</p> </li> </ul> </li> </ul>"
},
"maxDevices":{
"shape":"Integer",
"documentation":"<p>The maximum number of devices to be included in a test run.</p>"
}
},
"documentation":"<p>Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the <code>deviceSelectionConfiguration</code> request parameter in <a>ScheduleRun</a>.</p>"
"documentation":"<p>Represents the device filters used in a test run and the maximum number of devices to be included in the run. It is passed in as the <code>deviceSelectionConfiguration</code> request parameter in <a>ScheduleRun</a>.</p>"
},
"DeviceSelectionResult":{
"type":"structure",
@ -2097,7 +2331,7 @@
"documentation":"<p>The maximum number of devices to be selected by a device filter and included in a test run.</p>"
}
},
"documentation":"<p>Contains the run results requested by the device selection configuration as well as how many devices were returned. For an example of the JSON response syntax, see <a>ScheduleRun</a>.</p>"
"documentation":"<p>Contains the run results requested by the device selection configuration and how many devices were returned. For an example of the JSON response syntax, see <a>ScheduleRun</a>.</p>"
},
"Devices":{
"type":"list",
@ -2110,23 +2344,23 @@
"members":{
"jobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The number of minutes a test run will execute before it times out.</p>"
"documentation":"<p>The number of minutes a test run executes before it times out.</p>"
},
"accountsCleanup":{
"shape":"AccountsCleanup",
"documentation":"<p>True if account cleanup is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if account cleanup is enabled at the beginning of the test. Otherwise, false.</p>"
},
"appPackagesCleanup":{
"shape":"AppPackagesCleanup",
"documentation":"<p>True if app package cleanup is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if app package cleanup is enabled at the beginning of the test. Otherwise, false.</p>"
},
"videoCapture":{
"shape":"VideoCapture",
"documentation":"<p>Set to true to enable video capture; otherwise, set to false. The default is true.</p>"
"documentation":"<p>Set to true to enable video capture. Otherwise, set to false. The default is true.</p>"
},
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
}
},
"documentation":"<p>Represents configuration information about a test run, such as the execution timeout (in minutes).</p>"
@ -2200,7 +2434,7 @@
"members":{
"deviceInstance":{
"shape":"DeviceInstance",
"documentation":"<p>An object containing information about your device instance.</p>"
"documentation":"<p>An object that contains information about your device instance.</p>"
}
}
},
@ -2218,7 +2452,7 @@
},
"testType":{
"shape":"TestType",
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ.</p> </li> <li> <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT.</p> </li> <li> <p>APPIUM_JAVA_TESTNG.</p> </li> <li> <p>APPIUM_PYTHON.</p> </li> <li> <p>APPIUM_NODE.</p> </li> <li> <p>APPIUM_RUBY.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG.</p> </li> <li> <p>APPIUM_WEB_PYTHON.</p> </li> <li> <p>APPIUM_WEB_NODE.</p> </li> <li> <p>APPIUM_WEB_RUBY.</p> </li> <li> <p>CALABASH.</p> </li> <li> <p>INSTRUMENTATION.</p> </li> <li> <p>UIAUTOMATION.</p> </li> <li> <p>UIAUTOMATOR.</p> </li> <li> <p>XCTEST.</p> </li> <li> <p>XCTEST_UI.</p> </li> </ul>"
},
"test":{
"shape":"ScheduleRunTest",
@ -2226,7 +2460,7 @@
},
"configuration":{
"shape":"ScheduleRunConfiguration",
"documentation":"<p>An object containing information about the settings for a run.</p>"
"documentation":"<p>An object that contains information about the settings for a run.</p>"
}
},
"documentation":"<p>Represents a request to the get device pool compatibility operation.</p>"
@ -2261,7 +2495,7 @@
"members":{
"devicePool":{
"shape":"DevicePool",
"documentation":"<p>An object containing information about the requested device pool.</p>"
"documentation":"<p>An object that contains information about the requested device pool.</p>"
}
},
"documentation":"<p>Represents the result of a get device pool request.</p>"
@ -2282,7 +2516,7 @@
"members":{
"device":{
"shape":"Device",
"documentation":"<p>An object containing information about the requested device.</p>"
"documentation":"<p>An object that contains information about the requested device.</p>"
}
},
"documentation":"<p>Represents the result of a get device request.</p>"
@ -2293,7 +2527,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of your instance profile.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of an instance profile.</p>"
}
}
},
@ -2302,7 +2536,7 @@
"members":{
"instanceProfile":{
"shape":"InstanceProfile",
"documentation":"<p>An object containing information about your instance profile.</p>"
"documentation":"<p>An object that contains information about an instance profile.</p>"
}
}
},
@ -2322,7 +2556,7 @@
"members":{
"job":{
"shape":"Job",
"documentation":"<p>An object containing information about the requested job.</p>"
"documentation":"<p>An object that contains information about the requested job.</p>"
}
},
"documentation":"<p>Represents the result of a get job request.</p>"
@ -2333,7 +2567,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the network profile you want to return information about.</p>"
"documentation":"<p>The ARN of the network profile to return information about.</p>"
}
}
},
@ -2390,7 +2624,7 @@
"members":{
"project":{
"shape":"Project",
"documentation":"<p>The project you wish to get information about.</p>"
"documentation":"<p>The project to get information about.</p>"
}
},
"documentation":"<p>Represents the result of a get project request.</p>"
@ -2432,7 +2666,7 @@
"members":{
"run":{
"shape":"Run",
"documentation":"<p>The run you wish to get results from.</p>"
"documentation":"<p>The run to get results from.</p>"
}
},
"documentation":"<p>Represents the result of a get run request.</p>"
@ -2458,6 +2692,51 @@
},
"documentation":"<p>Represents the result of a get suite request.</p>"
},
"GetTestGridProjectRequest":{
"type":"structure",
"required":["projectArn"],
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN of the Selenium testing project, from either <a>CreateTestGridProject</a> or <a>ListTestGridProjects</a>.</p>"
}
}
},
"GetTestGridProjectResult":{
"type":"structure",
"members":{
"testGridProject":{
"shape":"TestGridProject",
"documentation":"<p>A <a>TestGridProject</a>.</p>"
}
}
},
"GetTestGridSessionRequest":{
"type":"structure",
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN for the project that this session belongs to. See <a>CreateTestGridProject</a> and <a>ListTestGridProjects</a>.</p>"
},
"sessionId":{
"shape":"ResourceId",
"documentation":"<p>An ID associated with this session.</p>"
},
"sessionArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>An ARN that uniquely identifies a <a>TestGridSession</a>.</p>"
}
}
},
"GetTestGridSessionResult":{
"type":"structure",
"members":{
"testGridSession":{
"shape":"TestGridSession",
"documentation":"<p>The <a>TestGridSession</a> that was requested.</p>"
}
}
},
"GetTestRequest":{
"type":"structure",
"required":["arn"],
@ -2515,7 +2794,7 @@
"members":{
"vpceConfiguration":{
"shape":"VPCEConfiguration",
"documentation":"<p>An object containing information about your VPC endpoint configuration.</p>"
"documentation":"<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
},
@ -2543,7 +2822,7 @@
},
"type":{
"shape":"DeviceAttribute",
"documentation":"<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>"
"documentation":"<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN</p> </li> <li> <p>FORM_FACTOR (for example, phone or tablet)</p> </li> <li> <p>MANUFACTURER</p> </li> <li> <p>PLATFORM (for example, Android or iOS)</p> </li> <li> <p>REMOTE_ACCESS_ENABLED</p> </li> <li> <p>APPIUM_VERSION</p> </li> </ul>"
}
},
"documentation":"<p>Represents information about incompatibility.</p>"
@ -2565,7 +2844,7 @@
},
"appArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the app about which you are requesting information.</p>"
"documentation":"<p>The ARN of the app about which you are requesting information.</p>"
}
},
"documentation":"<p>Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.</p>"
@ -2593,15 +2872,15 @@
},
"packageCleanup":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>"
"documentation":"<p>When set to <code>true</code>, Device Farm removes app packages after a test run. The default value is <code>false</code> for private devices.</p>"
},
"excludeAppPackagesFromCleanup":{
"shape":"PackageIds",
"documentation":"<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
"documentation":"<p>An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.</p> <p>The list of packages is considered only if you set <code>packageCleanup</code> to <code>true</code>.</p>"
},
"rebootAfterUse":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>"
"documentation":"<p>When set to <code>true</code>, Device Farm reboots the instance after a test run. The default value is <code>true</code>.</p>"
},
"name":{
"shape":"Name",
@ -2638,6 +2917,15 @@
"max":64,
"min":0
},
"InternalServiceException":{
"type":"structure",
"members":{
"message":{"shape":"Message"}
},
"documentation":"<p>An internal exception was raised in the service. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you see this error. </p>",
"exception":true,
"fault":true
},
"InvalidOperationException":{
"type":"structure",
"members":{
@ -2663,7 +2951,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The job's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The job's type.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -2671,11 +2959,11 @@
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The job's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
"documentation":"<p>The job's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The job's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The job's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"started":{
"shape":"DateTime",
@ -2699,7 +2987,7 @@
},
"instanceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the instance.</p>"
"documentation":"<p>The ARN of the instance.</p>"
},
"deviceMinutes":{
"shape":"DeviceMinutes",
@ -2711,7 +2999,7 @@
},
"videoCapture":{
"shape":"VideoCapture",
"documentation":"<p>This value is set to true if video capture is enabled; otherwise, it is set to false.</p>"
"documentation":"<p>This value is set to true if video capture is enabled. Otherwise, it is set to false.</p>"
}
},
"documentation":"<p>Represents a device.</p>"
@ -2741,11 +3029,11 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Run, Job, Suite, or Test ARN.</p>"
"documentation":"<p>The run, job, suite, or test ARN.</p>"
},
"type":{
"shape":"ArtifactCategory",
"documentation":"<p>The artifacts' type.</p> <p>Allowed values include:</p> <ul> <li> <p>FILE: The artifacts are files.</p> </li> <li> <p>LOG: The artifacts are logs.</p> </li> <li> <p>SCREENSHOT: The artifacts are screenshots.</p> </li> </ul>"
"documentation":"<p>The artifacts' type.</p> <p>Allowed values include:</p> <ul> <li> <p>FILE</p> </li> <li> <p>LOG</p> </li> <li> <p>SCREENSHOT</p> </li> </ul>"
},
"nextToken":{
"shape":"PaginationToken",
@ -2763,7 +3051,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list artifacts operation.</p>"
@ -2773,7 +3061,7 @@
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>An integer specifying the maximum number of items you want to return in the API response.</p>"
"documentation":"<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -2786,7 +3074,7 @@
"members":{
"deviceInstances":{
"shape":"DeviceInstances",
"documentation":"<p>An object containing information about your device instances.</p>"
"documentation":"<p>An object that contains information about your device instances.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -2822,7 +3110,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list device pools request.</p>"
@ -2840,7 +3128,7 @@
},
"filters":{
"shape":"DeviceFilters",
"documentation":"<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> </li> <li> <p>PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> </li> <li> <p>OS_VERSION: The operating system version. For example, \"10.3.2\".</p> </li> <li> <p>MODEL: The device model. For example, \"iPad 5th Gen\".</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> </li> <li> <p>MANUFACTURER: The device manufacturer. For example, \"Apple\".</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\". <i>This attribute will be ignored, as remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT_IN operators take a values array that has one or more elements.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.</p> </li> </ul> </li> </ul>"
"documentation":"<p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul> <li> <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p> </li> <li> <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p> </li> <li> <p>OS_VERSION: The operating system version (for example, 10.3.2).</p> </li> <li> <p>MODEL: The device model (for example, iPad 5th Gen).</p> </li> <li> <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> <li> <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p> </li> <li> <p>MANUFACTURER: The device manufacturer (for example, Apple).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> </li> <li> <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>, this attribute is ignored.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> <li> <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p> </li> </ul> </li> <li> <p>Operator: The filter operator.</p> <ul> <li> <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p> </li> <li> <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p> </li> <li> <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p> </li> <li> <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p> </li> </ul> </li> <li> <p>Values: An array of one or more filter values.</p> <ul> <li> <p>The IN and NOT_IN operators take a values array that has one or more elements.</p> </li> <li> <p>The other operators require an array with a single element.</p> </li> <li> <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Represents the result of a list devices request.</p>"
@ -2854,7 +3142,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list devices operation.</p>"
@ -2864,7 +3152,7 @@
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>An integer specifying the maximum number of items you want to return in the API response.</p>"
"documentation":"<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -2877,7 +3165,7 @@
"members":{
"instanceProfiles":{
"shape":"InstanceProfiles",
"documentation":"<p>An object containing information about your instance profiles.</p>"
"documentation":"<p>An object that contains information about your instance profiles.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -2909,7 +3197,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list jobs request.</p>"
@ -2924,7 +3212,7 @@
},
"type":{
"shape":"NetworkProfileType",
"documentation":"<p>The type of network profile you wish to return information about. Valid values are listed below.</p>"
"documentation":"<p>The type of network profile to return information about. Valid values are listed here.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3006,7 +3294,7 @@
"members":{
"offerings":{
"shape":"Offerings",
"documentation":"<p>A value representing the list offering results.</p>"
"documentation":"<p>A value that represents the list offering results.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3038,7 +3326,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list projects request.</p>"
@ -3063,7 +3351,7 @@
"members":{
"remoteAccessSessions":{
"shape":"RemoteAccessSessions",
"documentation":"<p>A container representing the metadata from the service about each remote access session you are requesting.</p>"
"documentation":"<p>A container that represents the metadata from the service about each remote access session you are requesting.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3096,7 +3384,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list runs request.</p>"
@ -3125,7 +3413,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list samples request.</p>"
@ -3154,7 +3442,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list suites request.</p>"
@ -3164,8 +3452,8 @@
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource(s) for which to list tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
"shape":"DeviceFarmArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
}
}
},
@ -3174,7 +3462,150 @@
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>"
}
}
},
"ListTestGridProjectsRequest":{
"type":"structure",
"members":{
"maxResult":{
"shape":"MaxPageSize",
"documentation":"<p>Return no more than this number of results.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>From a response, used to continue a paginated listing. </p>"
}
}
},
"ListTestGridProjectsResult":{
"type":"structure",
"members":{
"testGridProjects":{
"shape":"TestGridProjects",
"documentation":"<p>The list of TestGridProjects, based on a <a>ListTestGridProjectsRequest</a>.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Used for pagination. Pass into <a>ListTestGridProjects</a> to get more results in a paginated request.</p>"
}
}
},
"ListTestGridSessionActionsRequest":{
"type":"structure",
"required":["sessionArn"],
"members":{
"sessionArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN of the session to retrieve.</p>"
},
"maxResult":{
"shape":"MaxPageSize",
"documentation":"<p>The maximum number of sessions to return per response.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
"ListTestGridSessionActionsResult":{
"type":"structure",
"members":{
"actions":{
"shape":"TestGridSessionActions",
"documentation":"<p>The action taken by the session.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
"ListTestGridSessionArtifactsRequest":{
"type":"structure",
"required":["sessionArn"],
"members":{
"sessionArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN of a <a>TestGridSession</a>. </p>"
},
"type":{
"shape":"TestGridSessionArtifactCategory",
"documentation":"<p>Limit results to a specified type of artifact.</p>"
},
"maxResult":{
"shape":"MaxPageSize",
"documentation":"<p>The maximum number of results to be returned by a request.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
"ListTestGridSessionArtifactsResult":{
"type":"structure",
"members":{
"artifacts":{
"shape":"TestGridSessionArtifacts",
"documentation":"<p>A list of test grid session artifacts for a <a>TestGridSession</a>.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
"ListTestGridSessionsRequest":{
"type":"structure",
"required":["projectArn"],
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>ARN of a <a>TestGridProject</a>.</p>"
},
"status":{
"shape":"TestGridSessionStatus",
"documentation":"<p>Return only sessions in this state.</p>"
},
"creationTimeAfter":{
"shape":"DateTime",
"documentation":"<p>Return only sessions created after this time.</p>"
},
"creationTimeBefore":{
"shape":"DateTime",
"documentation":"<p>Return only sessions created before this time.</p>"
},
"endTimeAfter":{
"shape":"DateTime",
"documentation":"<p>Return only sessions that ended after this time.</p>"
},
"endTimeBefore":{
"shape":"DateTime",
"documentation":"<p>Return only sessions that ended before this time.</p>"
},
"maxResult":{
"shape":"MaxPageSize",
"documentation":"<p>Return only this many results at a time.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
"ListTestGridSessionsResult":{
"type":"structure",
"members":{
"testGridSessions":{
"shape":"TestGridSessions",
"documentation":"<p>The sessions that match the criteria in a <a>ListTestGridSessionsRequest</a>. </p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -3202,7 +3633,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list tests request.</p>"
@ -3227,11 +3658,11 @@
"members":{
"uniqueProblems":{
"shape":"UniqueProblemsByExecutionResultMap",
"documentation":"<p>Information about the unique problems.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>Information about the unique problems.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list unique problems request.</p>"
@ -3246,7 +3677,7 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The type of upload.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An Xcode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p> APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.</p> </li> </ul>"
"documentation":"<p>The type of upload.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP</p> </li> <li> <p>IOS_APP</p> </li> <li> <p>WEB_APP</p> </li> <li> <p>EXTERNAL_DATA</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p> </li> <li> <p>CALABASH_TEST_PACKAGE</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE</p> </li> <li> <p>XCTEST_TEST_PACKAGE</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC</p> </li> <li> <p> APPIUM_RUBY_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC</p> </li> <li> <p>XCTEST_UI_TEST_SPEC</p> </li> </ul>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3264,7 +3695,7 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"documentation":"<p>If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
}
},
"documentation":"<p>Represents the result of a list uploads request.</p>"
@ -3274,7 +3705,7 @@
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>An integer specifying the maximum number of items you want to return in the API response.</p>"
"documentation":"<p>An integer that specifies the maximum number of items you want to return in the API response.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3287,7 +3718,7 @@
"members":{
"vpceConfigurations":{
"shape":"VPCEConfigurations",
"documentation":"<p>An array of <code>VPCEConfiguration</code> objects containing information about your VPC endpoint configuration.</p>"
"documentation":"<p>An array of <code>VPCEConfiguration</code> objects that contain information about your VPC endpoint configuration.</p>"
},
"nextToken":{
"shape":"PaginationToken",
@ -3311,9 +3742,14 @@
"documentation":"<p>The longitude.</p>"
}
},
"documentation":"<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>"
"documentation":"<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example, 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>"
},
"Long":{"type":"long"},
"MaxPageSize":{
"type":"integer",
"max":1000,
"min":1
},
"MaxSlotMap":{
"type":"map",
"key":{"shape":"String"},
@ -3338,10 +3774,10 @@
},
"currencyCode":{
"shape":"CurrencyCode",
"documentation":"<p>The currency code of a monetary amount. For example, <code>USD</code> means \"U.S. dollars.\"</p>"
"documentation":"<p>The currency code of a monetary amount. For example, <code>USD</code> means U.S. dollars.</p>"
}
},
"documentation":"<p>A number representing the monetary amount for an offering or transaction.</p>"
"documentation":"<p>A number that represents the monetary amount for an offering or transaction.</p>"
},
"Name":{
"type":"string",
@ -3365,7 +3801,7 @@
},
"type":{
"shape":"NetworkProfileType",
"documentation":"<p>The type of network profile. Valid values are listed below.</p>"
"documentation":"<p>The type of network profile. Valid values are listed here.</p>"
},
"uplinkBandwidthBits":{
"shape":"Long",
@ -3444,15 +3880,15 @@
},
"description":{
"shape":"Message",
"documentation":"<p>A string describing the offering.</p>"
"documentation":"<p>A string that describes the offering.</p>"
},
"type":{
"shape":"OfferingType",
"documentation":"<p>The type of offering (e.g., \"RECURRING\") for a device.</p>"
"documentation":"<p>The type of offering (for example, <code>RECURRING</code>) for a device.</p>"
},
"platform":{
"shape":"DevicePlatform",
"documentation":"<p>The platform of the device (e.g., ANDROID or IOS).</p>"
"documentation":"<p>The platform of the device (for example, <code>ANDROID</code> or <code>IOS</code>).</p>"
},
"recurringCharges":{
"shape":"RecurringCharges",
@ -3474,7 +3910,7 @@
},
"description":{
"shape":"Message",
"documentation":"<p>A string describing the offering promotion.</p>"
"documentation":"<p>A string that describes the offering promotion.</p>"
}
},
"documentation":"<p>Represents information about an offering promotion.</p>"
@ -3599,7 +4035,7 @@
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The problem's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The problem's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"message":{
"shape":"Message",
@ -3639,7 +4075,7 @@
},
"defaultJobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The default number of minutes (at the project level) a test run will execute before it times out. The default value is 150 minutes.</p>"
"documentation":"<p>The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.</p>"
},
"created":{
"shape":"DateTime",
@ -3661,7 +4097,7 @@
},
"quantity":{
"shape":"Integer",
"documentation":"<p>The number of device slots you wish to purchase in an offering request.</p>"
"documentation":"<p>The number of device slots to purchase in an offering request.</p>"
},
"offeringPromotionId":{
"shape":"OfferingPromotionIdentifier",
@ -3678,7 +4114,7 @@
"documentation":"<p>Represents the offering transaction for the purchase result.</p>"
}
},
"documentation":"<p>The result of the purchase offering (e.g., success or failure).</p>"
"documentation":"<p>The result of the purchase offering (for example, success or failure).</p>"
},
"PurchasedDevicesMap":{
"type":"map",
@ -3690,19 +4126,19 @@
"members":{
"wifi":{
"shape":"Boolean",
"documentation":"<p>True if Wi-Fi is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.</p>"
},
"bluetooth":{
"shape":"Boolean",
"documentation":"<p>True if Bluetooth is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if Bluetooth is enabled at the beginning of the test. Otherwise, false.</p>"
},
"nfc":{
"shape":"Boolean",
"documentation":"<p>True if NFC is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if NFC is enabled at the beginning of the test. Otherwise, false.</p>"
},
"gps":{
"shape":"Boolean",
"documentation":"<p>True if GPS is enabled at the beginning of the test; otherwise, false.</p>"
"documentation":"<p>True if GPS is enabled at the beginning of the test. Otherwise, false.</p>"
}
},
"documentation":"<p>Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.</p>"
@ -3716,10 +4152,10 @@
},
"frequency":{
"shape":"RecurringChargeFrequency",
"documentation":"<p>The frequency in which charges will recur.</p>"
"documentation":"<p>The frequency in which charges recur.</p>"
}
},
"documentation":"<p>Specifies whether charges for devices will be recurring.</p>"
"documentation":"<p>Specifies whether charges for devices are recurring.</p>"
},
"RecurringChargeFrequency":{
"type":"string",
@ -3746,11 +4182,11 @@
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The status of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
"documentation":"<p>The status of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING.</p> </li> <li> <p>PENDING_CONCURRENCY.</p> </li> <li> <p>PENDING_DEVICE.</p> </li> <li> <p>PROCESSING.</p> </li> <li> <p>SCHEDULING.</p> </li> <li> <p>PREPARING.</p> </li> <li> <p>RUNNING.</p> </li> <li> <p>COMPLETED.</p> </li> <li> <p>STOPPING.</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The result of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The result of the remote access session. Can be any of the following:</p> <ul> <li> <p>PENDING.</p> </li> <li> <p>PASSED.</p> </li> <li> <p>WARNED.</p> </li> <li> <p>FAILED.</p> </li> <li> <p>SKIPPED.</p> </li> <li> <p>ERRORED.</p> </li> <li> <p>STOPPED.</p> </li> </ul>"
},
"message":{
"shape":"Message",
@ -3770,11 +4206,11 @@
},
"instanceArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the instance.</p>"
"documentation":"<p>The ARN of the instance.</p>"
},
"remoteDebugEnabled":{
"shape":"Boolean",
"documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"remoteRecordEnabled":{
"shape":"Boolean",
@ -3782,19 +4218,19 @@
},
"remoteRecordAppArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>"
"documentation":"<p>The ARN for the app to be recorded in the remote access session.</p>"
},
"hostAddress":{
"shape":"HostAddress",
"documentation":"<p>IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"clientId":{
"shape":"ClientId",
"documentation":"<p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>"
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.</p>"
},
"deviceMinutes":{
"shape":"DeviceMinutes",
@ -3806,15 +4242,15 @@
},
"deviceUdid":{
"shape":"String",
"documentation":"<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p> <p> <i>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p>"
"documentation":"<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p> <p>Remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</p>"
},
"interactionMode":{
"shape":"InteractionMode",
"documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You <b>cannot</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You <b>can</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You <b>can</b> run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
"documentation":"<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
},
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
}
},
"documentation":"<p>Represents information about the remote access session.</p>"
@ -3835,7 +4271,7 @@
"documentation":"<p>The quantity requested in an offering renewal.</p>"
}
},
"documentation":"<p>A request representing an offering renewal.</p>"
"documentation":"<p>A request that represents an offering renewal.</p>"
},
"RenewOfferingResult":{
"type":"structure",
@ -3861,12 +4297,30 @@
},
"documentation":"<p>Represents the screen resolution of a device in height and width, expressed in pixels.</p>"
},
"ResourceDescription":{
"type":"string",
"max":2048,
"min":1,
"pattern":".*\\S.*"
},
"ResourceId":{
"type":"string",
"max":128,
"min":1,
"pattern":".*\\S.*"
},
"ResourceName":{
"type":"string",
"max":64,
"min":1,
"pattern":".*\\S.*"
},
"Rule":{
"type":"structure",
"members":{
"attribute":{
"shape":"DeviceAttribute",
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>APPIUM_VERSION</dt> <dd> <p>The Appium version for the test.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are \"PHONE\" or \"TABLET\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p> <i>Supported operators</i>: <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p> <i>Supported operators</i>: <code>CONTAINS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer. For example, \"Apple\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model, such as \"Apple iPad Air 2\" or \"Google Pixel\".</p> <p> <i>Supported operators</i>: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version. For example, \"10.3.2\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are \"ANDROID\" or \"IOS\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".</p> <p> <i>Supported operators</i>: <code>EQUALS</code> </p> <p> <i>This filter will be ignored, as remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>.</i> </p> </dd> </dl>"
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>The supported operators for each attribute are provided in the following list.</p> <dl> <dt>APPIUM_VERSION</dt> <dd> <p>The Appium version for the test.</p> <p>Supported operators: <code>CONTAINS</code> </p> </dd> <dt>ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>.</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>AVAILABILITY</dt> <dd> <p>The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>FLEET_TYPE</dt> <dd> <p>The fleet type. Valid values are PUBLIC or PRIVATE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>FORM_FACTOR</dt> <dd> <p>The device form factor. Valid values are PHONE or TABLET.</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_ARN</dt> <dd> <p>The Amazon Resource Name (ARN) of the device instance.</p> <p>Supported operators: <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>INSTANCE_LABELS</dt> <dd> <p>The label of the device instance.</p> <p>Supported operators: <code>CONTAINS</code> </p> </dd> <dt>MANUFACTURER</dt> <dd> <p>The device manufacturer (for example, Apple).</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>MODEL</dt> <dd> <p>The device model, such as Apple iPad Air 2 or Google Pixel.</p> <p>Supported operators: <code>CONTAINS</code>, <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>OS_VERSION</dt> <dd> <p>The operating system version (for example, 10.3.2).</p> <p>Supported operators: <code>EQUALS</code>, <code>GREATER_THAN</code>, <code>GREATER_THAN_OR_EQUALS</code>, <code>IN</code>, <code>LESS_THAN</code>, <code>LESS_THAN_OR_EQUALS</code>, <code>NOT_IN</code> </p> </dd> <dt>PLATFORM</dt> <dd> <p>The device platform. Valid values are ANDROID or IOS.</p> <p>Supported operators: <code>EQUALS</code>, <code>IN</code>, <code>NOT_IN</code> </p> </dd> <dt>REMOTE_ACCESS_ENABLED</dt> <dd> <p>Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> </dd> <dt>REMOTE_DEBUG_ENABLED</dt> <dd> <p>Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.</p> <p>Supported operators: <code>EQUALS</code> </p> <p>Because remote debugging is <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html\">no longer supported</a>, this filter is ignored.</p> </dd> </dl>"
},
"operator":{
"shape":"RuleOperator",
@ -3909,11 +4363,11 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The run's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER</p> <note> <p>For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </note> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"
},
"platform":{
"shape":"DevicePlatform",
"documentation":"<p>The run's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID: The Android platform.</p> </li> <li> <p>IOS: The iOS platform.</p> </li> </ul>"
"documentation":"<p>The run's platform.</p> <p>Allowed values include:</p> <ul> <li> <p>ANDROID</p> </li> <li> <p>IOS</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -3921,11 +4375,11 @@
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The run's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
"documentation":"<p>The run's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The run's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The run's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"started":{
"shape":"DateTime",
@ -3953,7 +4407,7 @@
},
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p> <note> <p>If you have unmetered device slots, you must set this to <code>unmetered</code> to use them. Otherwise, the run is counted toward metered device minutes.</p> </note>"
},
"deviceMinutes":{
"shape":"DeviceMinutes",
@ -3965,7 +4419,7 @@
},
"parsingResultUrl":{
"shape":"String",
"documentation":"<p>Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.</p>"
"documentation":"<p>Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.</p>"
},
"resultCode":{
"shape":"ExecutionResultCode",
@ -3985,7 +4439,7 @@
},
"jobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The number of minutes the job will execute before it times out.</p>"
"documentation":"<p>The number of minutes the job executes before it times out.</p>"
},
"devicePoolArn":{
"shape":"AmazonResourceName",
@ -4013,7 +4467,7 @@
},
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.</p> <p>For more information about how Device Farm re-signs your apps, see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
},
"testSpecArn":{
"shape":"AmazonResourceName",
@ -4024,7 +4478,7 @@
"documentation":"<p>The results of a device filter used to select the devices for a test run.</p>"
}
},
"documentation":"<p>Represents a test run on a set of devices with a given app package, test parameters, etc.</p>"
"documentation":"<p>Represents a test run on a set of devices with a given app package, test parameters, and so on.</p>"
},
"Runs":{
"type":"list",
@ -4043,7 +4497,7 @@
},
"url":{
"shape":"URL",
"documentation":"<p>The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.</p>"
"documentation":"<p>The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.</p>"
}
},
"documentation":"<p>Represents a sample of performance data.</p>"
@ -4079,7 +4533,7 @@
"members":{
"extraDataPackageArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.</p>"
"documentation":"<p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external data for Android or the app's sandbox for iOS.</p>"
},
"networkProfileArn":{
"shape":"AmazonResourceName",
@ -4095,7 +4549,7 @@
},
"vpceConfigurationArns":{
"shape":"AmazonResourceNames",
"documentation":"<p>An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.</p>"
"documentation":"<p>An array of ARNs for your VPC endpoint configurations.</p>"
},
"customerArtifactPaths":{
"shape":"CustomerArtifactPaths",
@ -4107,11 +4561,11 @@
},
"auxiliaryApps":{
"shape":"AmazonResourceNames",
"documentation":"<p>A list of Upload ARNs for app packages that will be installed alongside your app.</p>"
"documentation":"<p>A list of upload ARNs for app packages to be installed with your app.</p>"
},
"billingMethod":{
"shape":"BillingMethod",
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
"documentation":"<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p> <note> <p>If you have purchased unmetered device slots, you must set this parameter to <code>unmetered</code> to make use of them. Otherwise, your run counts against your metered time.</p> </note>"
}
},
"documentation":"<p>Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.</p>"
@ -4129,7 +4583,7 @@
},
"appArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the app to schedule a run.</p>"
"documentation":"<p>The ARN of an application package to run tests against, created with <a>CreateUpload</a>. See <a>ListUploads</a>.</p>"
},
"devicePoolArn":{
"shape":"AmazonResourceName",
@ -4137,7 +4591,7 @@
},
"deviceSelectionConfiguration":{
"shape":"DeviceSelectionConfiguration",
"documentation":"<p>The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> is required in a request.</p>"
"documentation":"<p>The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.</p> <p>Either <b> <code>devicePoolArn</code> </b> or <b> <code>deviceSelectionConfiguration</code> </b> is required in a request.</p>"
},
"name":{
"shape":"Name",
@ -4174,11 +4628,11 @@
"members":{
"type":{
"shape":"TestType",
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"
},
"testPackageArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the uploaded test that will be run.</p>"
"documentation":"<p>The ARN of the uploaded test to be run.</p>"
},
"testSpecArn":{
"shape":"AmazonResourceName",
@ -4190,10 +4644,10 @@
},
"parameters":{
"shape":"TestParameters",
"documentation":"<p>The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.</p> <p>For all tests:</p> <ul> <li> <p>app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.</p> </li> </ul> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile, for example, \"my_profile_name\".</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are \"1.6.5\" (and higher), \"latest\", and \"default\".</p> <ul> <li> <p>“latest” will run the latest Appium version supported by Device Farm (1.9.1).</p> </li> <li> <p>For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For Fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: \"LoginTests\"</p> </li> <li> <p>Running a multiple test classes: \"LoginTests,SmokeTests\"</p> </li> <li> <p>Running a single test: \"LoginTests/testValid\"</p> </li> <li> <p>Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"</p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul>"
"documentation":"<p>The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.</p> <p>For all tests:</p> <ul> <li> <p> <code>app_performance_monitoring</code>: Performance monitoring is enabled by default. Set this parameter to false to disable it.</p> </li> </ul> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile (for example, <code>my_profile_name</code>).</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.</p> <ul> <li> <p>latest runs the latest Appium version supported by Device Farm (1.9.1).</p> </li> <li> <p>For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: <code>com.android.abc.Test1</code> </p> </li> <li> <p>Running a single test: <code>com.android.abc.Test1#smoke</code> </p> </li> <li> <p>Running multiple tests: <code>com.android.abc.Test1,com.android.abc.Test2</code> </p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: <code>LoginTests</code> </p> </li> <li> <p>Running a multiple test classes: <code>LoginTests,SmokeTests</code> </p> </li> <li> <p>Running a single test: <code>LoginTests/testValid</code> </p> </li> <li> <p>Running multiple tests: <code>LoginTests/testValid,LoginTests/testInvalid</code> </p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: <code>com.android.abc.Test1</code> </p> </li> <li> <p>Running a single test: <code>com.android.abc.Test1#smoke</code> </p> </li> <li> <p>Running multiple tests: <code>com.android.abc.Test1,com.android.abc.Test2</code> </p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Represents test settings. This data structure is passed in as the \"test\" parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p>"
"documentation":"<p>Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see <a>ScheduleRun</a>.</p>"
},
"ServiceAccountException":{
"type":"structure",
@ -4223,7 +4677,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.</p>"
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.</p>"
}
}
},
@ -4242,7 +4696,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the remote access session you wish to stop.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the remote access session to stop.</p>"
}
},
"documentation":"<p>Represents the request to stop the remote access session.</p>"
@ -4252,7 +4706,7 @@
"members":{
"remoteAccessSession":{
"shape":"RemoteAccessSession",
"documentation":"<p>A container representing the metadata from the service about the remote access session you are stopping.</p>"
"documentation":"<p>A container that represents the metadata from the service about the remote access session you are stopping.</p>"
}
},
"documentation":"<p>Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.</p>"
@ -4263,7 +4717,7 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.</p>"
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.</p>"
}
},
"documentation":"<p>Represents the request to stop a specific run.</p>"
@ -4292,7 +4746,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The suite's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The suite's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER </p> <note> <p>Only available for Android; an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </note> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -4300,11 +4754,11 @@
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The suite's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
"documentation":"<p>The suite's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The suite's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The suite's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"started":{
"shape":"DateTime",
@ -4342,14 +4796,14 @@
"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 that acts like a category for more specific tag values.</p>"
"documentation":"<p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label 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 descriptor within a tag category (key).</p>"
"documentation":"<p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a descriptor in a tag category (key).</p>"
}
},
"documentation":"<p>The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. </p>"
"documentation":"<p>The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters. </p>"
},
"TagKey":{
"type":"string",
@ -4392,12 +4846,12 @@
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource(s) to which to add tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
"shape":"DeviceFarmArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.</p>"
}
}
},
@ -4424,7 +4878,7 @@
},
"type":{
"shape":"TestType",
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_NODE: The Appium Node.js type.</p> </li> <li> <p>APPIUM_RUBY: The Appium Ruby type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE: The Appium Node.js type for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY: The Appium Ruby type for web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The Xcode test type.</p> </li> <li> <p>XCTEST_UI: The Xcode UI test type.</p> </li> </ul>"
"documentation":"<p>The test's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>BUILTIN_FUZZ</p> </li> <li> <p>BUILTIN_EXPLORER</p> <note> <p>For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.</p> </note> </li> <li> <p>APPIUM_JAVA_JUNIT</p> </li> <li> <p>APPIUM_JAVA_TESTNG</p> </li> <li> <p>APPIUM_PYTHON</p> </li> <li> <p>APPIUM_NODE</p> </li> <li> <p>APPIUM_RUBY</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG</p> </li> <li> <p>APPIUM_WEB_PYTHON</p> </li> <li> <p>APPIUM_WEB_NODE</p> </li> <li> <p>APPIUM_WEB_RUBY</p> </li> <li> <p>CALABASH</p> </li> <li> <p>INSTRUMENTATION</p> </li> <li> <p>UIAUTOMATION</p> </li> <li> <p>UIAUTOMATOR</p> </li> <li> <p>XCTEST</p> </li> <li> <p>XCTEST_UI</p> </li> </ul>"
},
"created":{
"shape":"DateTime",
@ -4432,11 +4886,11 @@
},
"status":{
"shape":"ExecutionStatus",
"documentation":"<p>The test's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending status.</p> </li> <li> <p>PENDING_CONCURRENCY: A pending concurrency status.</p> </li> <li> <p>PENDING_DEVICE: A pending device status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SCHEDULING: A scheduling status.</p> </li> <li> <p>PREPARING: A preparing status.</p> </li> <li> <p>RUNNING: A running status.</p> </li> <li> <p>COMPLETED: A completed status.</p> </li> <li> <p>STOPPING: A stopping status.</p> </li> </ul>"
"documentation":"<p>The test's status.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PENDING_CONCURRENCY</p> </li> <li> <p>PENDING_DEVICE</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SCHEDULING</p> </li> <li> <p>PREPARING</p> </li> <li> <p>RUNNING</p> </li> <li> <p>COMPLETED</p> </li> <li> <p>STOPPING</p> </li> </ul>"
},
"result":{
"shape":"ExecutionResult",
"documentation":"<p>The test's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
"documentation":"<p>The test's result.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>PASSED</p> </li> <li> <p>WARNED</p> </li> <li> <p>FAILED</p> </li> <li> <p>SKIPPED</p> </li> <li> <p>ERRORED</p> </li> <li> <p>STOPPED</p> </li> </ul>"
},
"started":{
"shape":"DateTime",
@ -4461,6 +4915,146 @@
},
"documentation":"<p>Represents a condition that is evaluated.</p>"
},
"TestGridProject":{
"type":"structure",
"members":{
"arn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN for the project.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>A human-readable name for the project.</p>"
},
"description":{
"shape":"String",
"documentation":"<p>A human-readable description for the project.</p>"
},
"created":{
"shape":"DateTime",
"documentation":"<p>When the project was created.</p>"
}
},
"documentation":"<p>A Selenium testing project. Projects are used to collect and collate sessions.</p>"
},
"TestGridProjects":{
"type":"list",
"member":{"shape":"TestGridProject"}
},
"TestGridSession":{
"type":"structure",
"members":{
"arn":{
"shape":"DeviceFarmArn",
"documentation":"<p>The ARN of the session.</p>"
},
"status":{
"shape":"TestGridSessionStatus",
"documentation":"<p>The state of the session.</p>"
},
"created":{
"shape":"DateTime",
"documentation":"<p>The time that the session was started.</p>"
},
"ended":{
"shape":"DateTime",
"documentation":"<p>The time the session ended.</p>"
},
"billingMinutes":{
"shape":"Double",
"documentation":"<p>The number of billed minutes that were used for this session. </p>"
},
"seleniumProperties":{
"shape":"String",
"documentation":"<p>A JSON object of options and parameters passed to the Selenium WebDriver.</p>"
}
},
"documentation":"<p>A <a>TestGridSession</a> is a single instance of a browser launched from the URL provided by a call to <a>CreateTestGridUrl</a>.</p>"
},
"TestGridSessionAction":{
"type":"structure",
"members":{
"action":{
"shape":"String",
"documentation":"<p>The action taken by the session.</p>"
},
"started":{
"shape":"DateTime",
"documentation":"<p>The time that the session invoked the action.</p>"
},
"duration":{
"shape":"Long",
"documentation":"<p>The time, in milliseconds, that the action took to complete in the browser.</p>"
},
"statusCode":{
"shape":"String",
"documentation":"<p>HTTP status code returned to the browser when the action was taken.</p>"
},
"requestMethod":{
"shape":"String",
"documentation":"<p>HTTP method that the browser used to make the request.</p>"
}
},
"documentation":"<p>An action taken by a <a>TestGridSession</a> browser instance.</p>"
},
"TestGridSessionActions":{
"type":"list",
"member":{"shape":"TestGridSessionAction"}
},
"TestGridSessionArtifact":{
"type":"structure",
"members":{
"filename":{
"shape":"String",
"documentation":"<p>The file name of the artifact.</p>"
},
"type":{
"shape":"TestGridSessionArtifactType",
"documentation":"<p>The kind of artifact.</p>"
},
"url":{
"shape":"String",
"documentation":"<p>A semi-stable URL to the content of the object.</p>"
}
},
"documentation":"<p>Artifacts are video and other files that are produced in the process of running a browser in an automated context. </p> <note> <p>Video elements might be broken up into multiple artifacts as they grow in size during creation. </p> </note>"
},
"TestGridSessionArtifactCategory":{
"type":"string",
"enum":[
"VIDEO",
"LOG"
]
},
"TestGridSessionArtifactType":{
"type":"string",
"enum":[
"UNKNOWN",
"VIDEO",
"SELENIUM_LOG"
]
},
"TestGridSessionArtifacts":{
"type":"list",
"member":{"shape":"TestGridSessionArtifact"}
},
"TestGridSessionStatus":{
"type":"string",
"enum":[
"ACTIVE",
"CLOSED",
"ERRORED"
]
},
"TestGridSessions":{
"type":"list",
"member":{"shape":"TestGridSession"}
},
"TestGridUrlExpiresInSecondsInput":{
"type":"integer",
"max":86400,
"min":60
},
"TestParameters":{
"type":"map",
"key":{"shape":"String"},
@ -4559,8 +5153,8 @@
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource(s) from which to delete tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
"shape":"DeviceFarmArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: <code>PROJECT</code>, <code>RUN</code>, <code>NETWORK_PROFILE</code>, <code>INSTANCE_PROFILE</code>, <code>DEVICE_INSTANCE</code>, <code>SESSION</code>, <code>DEVICE_POOL</code>, <code>DEVICE</code>, and <code>VPCE_CONFIGURATION</code>.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
@ -4583,7 +5177,7 @@
},
"profileArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.</p>"
"documentation":"<p>The ARN of the profile that you want to associate with the device instance.</p>"
},
"labels":{
"shape":"InstanceLabels",
@ -4596,7 +5190,7 @@
"members":{
"deviceInstance":{
"shape":"DeviceInstance",
"documentation":"<p>An object containing information about your device instance.</p>"
"documentation":"<p>An object that contains information about your device instance.</p>"
}
}
},
@ -4606,19 +5200,19 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the Device Farm device pool you wish to update.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Device Farm device pool to update.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>A string representing the name of the device pool you wish to update.</p>"
"documentation":"<p>A string that represents the name of the device pool to update.</p>"
},
"description":{
"shape":"Message",
"documentation":"<p>A description of the device pool you wish to update.</p>"
"documentation":"<p>A description of the device pool to update.</p>"
},
"rules":{
"shape":"Rules",
"documentation":"<p>Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.</p>"
"documentation":"<p>Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.</p>"
},
"maxDevices":{
"shape":"Integer",
@ -4626,7 +5220,7 @@
},
"clearMaxDevices":{
"shape":"Boolean",
"documentation":"<p>Sets whether the <code>maxDevices</code> parameter applies to your device pool. If you set this parameter to <code>true</code>, the <code>maxDevices</code> parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the <code>rules</code> parameter.</p> <p>If you use this parameter in your request, you cannot use the <code>maxDevices</code> parameter in the same request.</p>"
"documentation":"<p>Sets whether the <code>maxDevices</code> parameter applies to your device pool. If you set this parameter to <code>true</code>, the <code>maxDevices</code> parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the <code>rules</code> parameter.</p> <p>If you use this parameter in your request, you cannot use the <code>maxDevices</code> parameter in the same request.</p>"
}
},
"documentation":"<p>Represents a request to the update device pool operation.</p>"
@ -4663,7 +5257,7 @@
},
"excludeAppPackagesFromCleanup":{
"shape":"PackageIds",
"documentation":"<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
"documentation":"<p>An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
},
"rebootAfterUse":{
"shape":"Boolean",
@ -4676,7 +5270,7 @@
"members":{
"instanceProfile":{
"shape":"InstanceProfile",
"documentation":"<p>An object containing information about your instance profile.</p>"
"documentation":"<p>An object that contains information about your instance profile.</p>"
}
}
},
@ -4698,7 +5292,7 @@
},
"type":{
"shape":"NetworkProfileType",
"documentation":"<p>The type of network profile you wish to return information about. Valid values are listed below.</p>"
"documentation":"<p>The type of network profile to return information about. Valid values are listed here.</p>"
},
"uplinkBandwidthBits":{
"shape":"Long",
@ -4749,15 +5343,15 @@
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the project whose name you wish to update.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the project whose name to update.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>A string representing the new name of the project that you are updating.</p>"
"documentation":"<p>A string that represents the new name of the project that you are updating.</p>"
},
"defaultJobTimeoutMinutes":{
"shape":"JobTimeoutMinutes",
"documentation":"<p>The number of minutes a test run in the project will execute before it times out.</p>"
"documentation":"<p>The number of minutes a test run in the project executes before it times out.</p>"
}
},
"documentation":"<p>Represents a request to the update project operation.</p>"
@ -4767,11 +5361,38 @@
"members":{
"project":{
"shape":"Project",
"documentation":"<p>The project you wish to update.</p>"
"documentation":"<p>The project to update.</p>"
}
},
"documentation":"<p>Represents the result of an update project request.</p>"
},
"UpdateTestGridProjectRequest":{
"type":"structure",
"required":["projectArn"],
"members":{
"projectArn":{
"shape":"DeviceFarmArn",
"documentation":"<p>ARN of the project to update.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>Human-readable name for the project.</p>"
},
"description":{
"shape":"ResourceDescription",
"documentation":"<p>Human-readable description for the project.</p>"
}
}
},
"UpdateTestGridProjectResult":{
"type":"structure",
"members":{
"testGridProject":{
"shape":"TestGridProject",
"documentation":"<p>The project, including updated information.</p>"
}
}
},
"UpdateUploadRequest":{
"type":"structure",
"required":["arn"],
@ -4782,15 +5403,15 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the <code>.yaml</code> or <code>.yml</code> file extension.</p>"
"documentation":"<p>The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the <code>.yaml</code> or <code>.yml</code> file extension.</p>"
},
"contentType":{
"shape":"ContentType",
"documentation":"<p>The upload's content type (for example, \"application/x-yaml\").</p>"
"documentation":"<p>The upload's content type (for example, <code>application/x-yaml</code>).</p>"
},
"editContent":{
"shape":"Boolean",
"documentation":"<p>Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.</p>"
"documentation":"<p>Set to true if the YAML file has changed and must be updated. Otherwise, set to false.</p>"
}
}
},
@ -4813,19 +5434,19 @@
},
"vpceConfigurationName":{
"shape":"VPCEConfigurationName",
"documentation":"<p>The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.</p>"
"documentation":"<p>The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.</p>"
},
"vpceServiceName":{
"shape":"VPCEServiceName",
"documentation":"<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>"
"documentation":"<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>"
},
"serviceDnsName":{
"shape":"ServiceDnsName",
"documentation":"<p>The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.</p>"
"documentation":"<p>The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.</p>"
},
"vpceConfigurationDescription":{
"shape":"VPCEConfigurationDescription",
"documentation":"<p>An optional description, providing more details about your VPC endpoint configuration.</p>"
"documentation":"<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
}
},
@ -4834,7 +5455,7 @@
"members":{
"vpceConfiguration":{
"shape":"VPCEConfiguration",
"documentation":"<p>An object containing information about your VPC endpoint configuration.</p>"
"documentation":"<p>An object that contains information about your VPC endpoint configuration.</p>"
}
}
},
@ -4855,15 +5476,15 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The upload's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An Xcode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.</p> </li> </ul>"
"documentation":"<p>The upload's type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP</p> </li> <li> <p>IOS_APP</p> </li> <li> <p>WEB_APP</p> </li> <li> <p>EXTERNAL_DATA</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_RUBY_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_PACKAGE</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_PACKAGE</p> </li> <li> <p>CALABASH_TEST_PACKAGE</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE</p> </li> <li> <p>XCTEST_TEST_PACKAGE</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_NODE_TEST_SPEC</p> </li> <li> <p>APPIUM_RUBY_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_NODE_TEST_SPEC</p> </li> <li> <p>APPIUM_WEB_RUBY_TEST_SPEC</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC</p> </li> <li> <p>XCTEST_UI_TEST_SPEC</p> </li> </ul>"
},
"status":{
"shape":"UploadStatus",
"documentation":"<p>The upload's status.</p> <p>Must be one of the following values:</p> <ul> <li> <p>FAILED: A failed status.</p> </li> <li> <p>INITIALIZED: An initialized status.</p> </li> <li> <p>PROCESSING: A processing status.</p> </li> <li> <p>SUCCEEDED: A succeeded status.</p> </li> </ul>"
"documentation":"<p>The upload's status.</p> <p>Must be one of the following values:</p> <ul> <li> <p>FAILED</p> </li> <li> <p>INITIALIZED</p> </li> <li> <p>PROCESSING</p> </li> <li> <p>SUCCEEDED</p> </li> </ul>"
},
"url":{
"shape":"URL",
"documentation":"<p>The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.</p>"
"documentation":"<p>The presigned Amazon S3 URL that was used to store a file using a PUT request.</p>"
},
"metadata":{
"shape":"Metadata",
@ -4871,7 +5492,7 @@
},
"contentType":{
"shape":"ContentType",
"documentation":"<p>The upload's content type (for example, \"application/octet-stream\").</p>"
"documentation":"<p>The upload's content type (for example, <code>application/octet-stream</code>).</p>"
},
"message":{
"shape":"Message",
@ -4950,11 +5571,11 @@
},
"vpceConfigurationName":{
"shape":"VPCEConfigurationName",
"documentation":"<p>The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.</p>"
"documentation":"<p>The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.</p>"
},
"vpceServiceName":{
"shape":"VPCEServiceName",
"documentation":"<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>"
"documentation":"<p>The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.</p>"
},
"serviceDnsName":{
"shape":"ServiceDnsName",
@ -4962,7 +5583,7 @@
},
"vpceConfigurationDescription":{
"shape":"VPCEConfigurationDescription",
"documentation":"<p>An optional description, providing more details about your VPC endpoint configuration.</p>"
"documentation":"<p>An optional description that provides details about your VPC endpoint configuration.</p>"
}
},
"documentation":"<p>Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
@ -4988,5 +5609,5 @@
},
"VideoCapture":{"type":"boolean"}
},
"documentation":"<p>AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.</p>"
"documentation":"<p>Welcome to the AWS Device Farm API documentation, which contains APIs for:</p> <ul> <li> <p>Testing on desktop browsers</p> <p> Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain <code>TestGrid</code> in their names. For more information, see <a href=\"https://docs.aws.amazon.com/devicefarm/latest/testgrid/\">Testing Web Applications on Selenium with Device Farm</a>.</p> </li> <li> <p>Testing on real mobile devices</p> <p>Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the <a href=\"https://docs.aws.amazon.com/devicefarm/latest/developerguide/\">Device Farm Developer Guide</a>.</p> </li> </ul>"
}

View file

@ -148,7 +148,7 @@
{"shape":"ServerInternalErrorException"},
{"shape":"HomeRegionNotSetException"}
],
"documentation":"<p>Retrieves attributes for a list of configuration item IDs.</p> <note> <p>All of the supplied IDs must be for the same asset type from one of the following:</p> <ul> <li> <p>server</p> </li> <li> <p>application</p> </li> <li> <p>process</p> </li> <li> <p>connection</p> </li> </ul> <p>Output fields are specific to the asset type specified. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#DescribeConfigurations\">Using the DescribeConfigurations Action</a>.</p> </note>"
"documentation":"<p>Retrieves attributes for a list of configuration item IDs.</p> <note> <p>All of the supplied IDs must be for the same asset type from one of the following:</p> <ul> <li> <p>server</p> </li> <li> <p>application</p> </li> <li> <p>process</p> </li> <li> <p>connection</p> </li> </ul> <p>Output fields are specific to the asset type specified. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.</p> <p>For a complete list of outputs for each asset type, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations\">Using the DescribeConfigurations Action</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> </note>"
},
"DescribeContinuousExports":{
"name":"DescribeContinuousExports",
@ -308,7 +308,7 @@
{"shape":"ServerInternalErrorException"},
{"shape":"HomeRegionNotSetException"}
],
"documentation":"<p>Retrieves a list of configuration items as specified by the value passed to the required paramater <code>configurationType</code>. Optional filtering may be applied to refine search results.</p>"
"documentation":"<p>Retrieves a list of configuration items as specified by the value passed to the required parameter <code>configurationType</code>. Optional filtering may be applied to refine search results.</p>"
},
"ListServerNeighbors":{
"name":"ListServerNeighbors",
@ -398,7 +398,7 @@
{"shape":"ServerInternalErrorException"},
{"shape":"HomeRegionNotSetException"}
],
"documentation":"<p>Starts an import task, which allows you to import details of your on-premises environment directly into AWS without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.</p> <p>To start an import request, do this:</p> <ol> <li> <p>Download the specially formatted comma separated value (CSV) import template, which you can find here: <a href=\"https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv\">https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv</a>.</p> </li> <li> <p>Fill out the template with your server and application data.</p> </li> <li> <p>Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.</p> </li> <li> <p>Use the console or the <code>StartImportTask</code> command with the AWS CLI or one of the AWS SDKs to import the records from your file.</p> </li> </ol> <p>For more information, including step-by-step procedures, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html\">Migration Hub Import</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> <note> <p>There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html\">AWS Application Discovery Service Limits</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> </note>"
"documentation":"<p>Starts an import task, which allows you to import details of your on-premises environment directly into AWS Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.</p> <p>To start an import request, do this:</p> <ol> <li> <p>Download the specially formatted comma separated value (CSV) import template, which you can find here: <a href=\"https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv\">https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv</a>.</p> </li> <li> <p>Fill out the template with your server and application data.</p> </li> <li> <p>Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.</p> </li> <li> <p>Use the console or the <code>StartImportTask</code> command with the AWS CLI or one of the AWS SDKs to import the records from your file.</p> </li> </ol> <p>For more information, including step-by-step procedures, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html\">Migration Hub Import</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> <note> <p>There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html\">AWS Application Discovery Service Limits</a> in the <i>AWS Application Discovery Service User Guide</i>.</p> </note>"
},
"StopContinuousExport":{
"name":"StopContinuousExport",
@ -1337,7 +1337,7 @@
"documentation":"<p>A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by <i>AND</i>. If you specify multiple values for a particular filter, the system differentiates the values using <i>OR</i>. Calling either <i>DescribeConfigurations</i> or <i>ListConfigurations</i> returns attributes of matching configuration items.</p>"
}
},
"documentation":"<p>A filter that can use conditional operators.</p> <p>For more information about filters, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html\">Querying Discovered Configuration Items</a>. </p>"
"documentation":"<p>A filter that can use conditional operators.</p> <p>For more information about filters, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html\">Querying Discovered Configuration Items</a> in the <i>AWS Application Discovery Service User Guide</i>. </p>"
},
"FilterName":{"type":"string"},
"FilterValue":{"type":"string"},
@ -1540,7 +1540,7 @@
},
"filters":{
"shape":"Filters",
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations\">Querying Discovered Configuration Items</a>. </p>"
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations\">Using the ListConfigurations Action</a> in the <i>AWS Application Discovery Service User Guide</i>.</p>"
},
"maxResults":{
"shape":"Integer",
@ -1552,7 +1552,7 @@
},
"orderBy":{
"shape":"OrderByList",
"documentation":"<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations\">Using the ListConfigurations Action</a>.</p>"
"documentation":"<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href=\"https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations\">Using the ListConfigurations Action</a> in the <i>AWS Application Discovery Service User Guide</i>.</p>"
}
}
},
@ -1952,5 +1952,5 @@
]
}
},
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an AWS-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see <a href=\"http://aws.amazon.com/application-discovery/faqs/\">AWS Application Discovery Service FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation:</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. </p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>We recommend that you use agent-based discovery for non-VMware environments and to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts.</p> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.</p> </important> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p> <note> <p>Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a <code>HomeRegionNotSetException</code> error will be returned. Also, you must make the API calls while in your home region.</p> </note>"
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the <a href=\"http://aws.amazon.com/application-discovery/faqs/\">AWS Application Discovery Service FAQ</a>. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:</p> <ul> <li> <p> <b>Agentless discovery</b> is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. It does not work in non-VMware environments.</p> <ul> <li> <p>Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.</p> </li> <li> <p>Agentless discovery doesn't collect information about network dependencies, only agent-based discovery collects that information.</p> </li> </ul> </li> </ul> <ul> <li> <p> <b>Agent-based discovery</b> collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center.</p> <ul> <li> <p> The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.</p> </li> <li> <p>The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> </li> </ul> <ul> <li> <p> <b>AWS Partner Network (APN) solutions</b> integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Migration Hub without using the discovery connector or discovery agent.</p> <ul> <li> <p>Third-party application discovery tools can query AWS Application Discovery Service, and they can write to the Application Discovery Service database using the public API.</p> </li> <li> <p>In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.</p> </li> </ul> </li> </ul> <p> <b>Recommendations</b> </p> <p>We recommend that you use agent-based discovery for non-VMware environments, and whenever you want to collect information about network dependencies. You can run agent-based and agentless discovery simultaneously. Use agentless discovery to complete the initial infrastructure assessment quickly, and then install agents on select hosts to collect additional information.</p> <p> <b>Working With This Guide</b> </p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <note> <ul> <li> <p>Remember that you must set your Migration Hub home region before you call any of these APIs.</p> </li> <li> <p>You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a <code>HomeRegionNotSetException</code> error is returned.</p> </li> <li> <p>API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.</p> </li> <li> <p>Although it is unlikely, the Migration Hub home region could change. If you call APIs outside the home region, an <code>InvalidInputException</code> is returned.</p> </li> <li> <p>You must call <code>GetHomeRegion</code> to obtain the latest Migration Hub home region.</p> </li> </ul> </note> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\">AWS Application Discovery Service User Guide</a>.</p> <important> <p>All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.</p> </important>"
}

View file

@ -149,7 +149,14 @@
"max":10,
"min":1
},
"CmkArn":{
"type":"string",
"max":2048,
"min":0,
"pattern":"arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/.*"
},
"CopyTags":{"type":"boolean"},
"CopyTagsNullable":{"type":"boolean"},
"Count":{
"type":"integer",
"max":1000,
@ -217,6 +224,56 @@
},
"documentation":"<p>Specifies when to create snapshots of EBS volumes.</p>"
},
"CrossRegionCopyRetainRule":{
"type":"structure",
"members":{
"Interval":{
"shape":"Interval",
"documentation":"<p>The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.</p>"
},
"IntervalUnit":{
"shape":"RetentionIntervalUnitValues",
"documentation":"<p>The unit of time for time-based retention.</p>"
}
},
"documentation":"<p>Specifies the retention rule for cross-Region snapshot copies.</p>"
},
"CrossRegionCopyRule":{
"type":"structure",
"required":[
"TargetRegion",
"Encrypted"
],
"members":{
"TargetRegion":{
"shape":"TargetRegion",
"documentation":"<p>The target Region.</p>"
},
"Encrypted":{
"shape":"Encrypted",
"documentation":"<p>To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled.</p>"
},
"CmkArn":{
"shape":"CmkArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used.</p>"
},
"CopyTags":{
"shape":"CopyTagsNullable",
"documentation":"<p>Copy all user-defined tags from the source snapshot to the copied snapshot.</p>"
},
"RetainRule":{
"shape":"CrossRegionCopyRetainRule",
"documentation":"<p>The retention rule.</p>"
}
},
"documentation":"<p>Specifies a rule for cross-Region snapshot copies.</p>"
},
"CrossRegionCopyRules":{
"type":"list",
"member":{"shape":"CrossRegionCopyRule"},
"max":3,
"min":0
},
"DeleteLifecyclePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
@ -234,6 +291,7 @@
"members":{
}
},
"Encrypted":{"type":"boolean"},
"ErrorCode":{"type":"string"},
"ErrorMessage":{"type":"string"},
"ExcludeBootVolume":{"type":"boolean"},
@ -241,7 +299,7 @@
"type":"string",
"max":2048,
"min":0,
"pattern":"arn:aws:iam::\\d+:role/.*"
"pattern":"arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/.*"
},
"FastRestoreRule":{
"type":"structure",
@ -492,14 +550,16 @@
"members":{
"ExcludeBootVolume":{
"shape":"ExcludeBootVolume",
"documentation":"<p>When executing an EBS Snapshot Management Instance policy, execute all CreateSnapshots calls with the <code>excludeBootVolume</code> set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management Instance policies.</p>"
"documentation":"<p>[EBS Snapshot Management Instance policies only] Indicates whether to exclude the root volume from snapshots created using <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html\">CreateSnapshots</a>. The default is false.</p>"
}
},
"documentation":"<p>Optional parameters that can be added to the policy. The set of valid parameters depends on the combination of <code>policyType</code> and <code>resourceType</code> values.</p>"
"documentation":"<p>Specifies optional parameters to add to a policy. The set of valid parameters depends on the combination of policy type and resource type.</p>"
},
"PolicyArn":{
"type":"string",
"pattern":"^arn:aws:dlm:[A-Za-z0-9_/.-]{0,63}:\\d+:policy/[0-9A-Za-z_-]{1,128}$"
"max":2048,
"min":0,
"pattern":"^arn:aws(-[a-z]{1,3}){0,2}:dlm:[A-Za-z0-9_/.-]{0,63}:\\d+:policy/[0-9A-Za-z_-]{1,128}$"
},
"PolicyDescription":{
"type":"string",
@ -512,7 +572,7 @@
"members":{
"PolicyType":{
"shape":"PolicyTypeValues",
"documentation":"<p>This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present.</p>"
"documentation":"<p>The valid target resource types and actions a policy can manage. The default is EBS_SNAPSHOT_MANAGEMENT.</p>"
},
"ResourceTypes":{
"shape":"ResourceTypeValuesList",
@ -528,7 +588,7 @@
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>A set of optional parameters that can be provided by the policy. </p>"
"documentation":"<p>A set of optional parameters for the policy. </p>"
}
},
"documentation":"<p>Specifies the configuration of a lifecycle policy.</p>"
@ -626,7 +686,7 @@
},
"CreateRule":{
"shape":"CreateRule",
"documentation":"<p>The create rule.</p>"
"documentation":"<p>The creation rule.</p>"
},
"RetainRule":{
"shape":"RetainRule",
@ -634,10 +694,14 @@
},
"FastRestoreRule":{
"shape":"FastRestoreRule",
"documentation":"<p>Enable fast snapshot restore.</p>"
"documentation":"<p>The rule for enabling fast snapshot restore.</p>"
},
"CrossRegionCopyRules":{
"shape":"CrossRegionCopyRules",
"documentation":"<p>The rule for cross-Region snapshot copies.</p>"
}
},
"documentation":"<p>Specifies a schedule.</p>"
"documentation":"<p>Specifies a backup schedule.</p>"
},
"ScheduleList":{
"type":"list",
@ -739,7 +803,8 @@
},
"TagValue":{
"type":"string",
"max":256
"max":256,
"pattern":"[\\p{all}]*"
},
"TagsToAddFilterList":{
"type":"list",
@ -750,9 +815,15 @@
"TagsToAddList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"max":45,
"min":0
},
"TargetRegion":{
"type":"string",
"max":16,
"min":0,
"pattern":"([a-z]+-){2,3}\\d"
},
"TargetTagList":{
"type":"list",
"member":{"shape":"Tag"},
@ -842,7 +913,7 @@
"VariableTagsList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"max":45,
"min":0
}
},

View file

@ -61,7 +61,7 @@
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Copies the specified DB cluster parameter group.</p>"
"documentation":"<p>Copies the specified cluster parameter group.</p>"
},
"CopyDBClusterSnapshot":{
"name":"CopyDBClusterSnapshot",
@ -82,7 +82,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>To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in the <i>copying</i> status.</p>"
"documentation":"<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared cluster snapshot.</p> <p>To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in the <i>copying</i> status.</p>"
},
"CreateDBCluster":{
"name":"CreateDBCluster",
@ -112,7 +112,7 @@
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}
],
"documentation":"<p>Creates a new Amazon DocumentDB DB cluster.</p>"
"documentation":"<p>Creates a new Amazon DocumentDB cluster.</p>"
},
"CreateDBClusterParameterGroup":{
"name":"CreateDBClusterParameterGroup",
@ -129,7 +129,7 @@
{"shape":"DBParameterGroupQuotaExceededFault"},
{"shape":"DBParameterGroupAlreadyExistsFault"}
],
"documentation":"<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.</p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
"documentation":"<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover.</p> <important> <p>After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
},
"CreateDBClusterSnapshot":{
"name":"CreateDBClusterSnapshot",
@ -149,7 +149,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
"documentation":"<p>Creates a snapshot of a DB cluster. </p>"
"documentation":"<p>Creates a snapshot of a cluster. </p>"
},
"CreateDBInstance":{
"name":"CreateDBInstance",
@ -179,7 +179,7 @@
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Creates a new DB instance.</p>"
"documentation":"<p>Creates a new instance.</p>"
},
"CreateDBSubnetGroup":{
"name":"CreateDBSubnetGroup",
@ -199,7 +199,7 @@
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"<p>Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
"documentation":"<p>Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
},
"DeleteDBCluster":{
"name":"DeleteDBCluster",
@ -219,7 +219,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterSnapshotStateFault"}
],
"documentation":"<p>Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p/>"
"documentation":"<p>Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.</p> <p/>"
},
"DeleteDBClusterParameterGroup":{
"name":"DeleteDBClusterParameterGroup",
@ -232,7 +232,7 @@
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</p>"
"documentation":"<p>Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.</p>"
},
"DeleteDBClusterSnapshot":{
"name":"DeleteDBClusterSnapshot",
@ -249,7 +249,7 @@
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note>"
"documentation":"<p>Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note>"
},
"DeleteDBInstance":{
"name":"DeleteDBInstance",
@ -269,7 +269,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"InvalidDBClusterStateFault"}
],
"documentation":"<p>Deletes a previously provisioned DB instance. </p>"
"documentation":"<p>Deletes a previously provisioned instance. </p>"
},
"DeleteDBSubnetGroup":{
"name":"DeleteDBSubnetGroup",
@ -283,7 +283,7 @@
{"shape":"InvalidDBSubnetStateFault"},
{"shape":"DBSubnetGroupNotFoundFault"}
],
"documentation":"<p>Deletes a DB subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>"
"documentation":"<p>Deletes a subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>"
},
"DescribeCertificates":{
"name":"DescribeCertificates",
@ -299,7 +299,7 @@
"errors":[
{"shape":"CertificateNotFoundFault"}
],
"documentation":"<p>Returns a list of certificate authority (CA) certificates provided by Amazon RDS for this AWS account.</p>"
"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>"
},
"DescribeDBClusterParameterGroups":{
"name":"DescribeDBClusterParameterGroups",
@ -315,7 +315,7 @@
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains only the description of the specified DB cluster parameter group. </p>"
"documentation":"<p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list contains only the description of the specified cluster parameter group. </p>"
},
"DescribeDBClusterParameters":{
"name":"DescribeDBClusterParameters",
@ -331,7 +331,7 @@
"errors":[
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p>Returns the detailed parameter list for a particular DB cluster parameter group.</p>"
"documentation":"<p>Returns the detailed parameter list for a particular cluster parameter group.</p>"
},
"DescribeDBClusterSnapshotAttributes":{
"name":"DescribeDBClusterSnapshotAttributes",
@ -347,7 +347,7 @@
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other AWS accounts, <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.</p>"
"documentation":"<p>Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.</p> <p>When you share snapshots with other AWS accounts, <code>DescribeDBClusterSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.</p>"
},
"DescribeDBClusterSnapshots":{
"name":"DescribeDBClusterSnapshots",
@ -363,7 +363,7 @@
"errors":[
{"shape":"DBClusterSnapshotNotFoundFault"}
],
"documentation":"<p>Returns information about DB cluster snapshots. This API operation supports pagination.</p>"
"documentation":"<p>Returns information about cluster snapshots. This API operation supports pagination.</p>"
},
"DescribeDBClusters":{
"name":"DescribeDBClusters",
@ -379,7 +379,7 @@
"errors":[
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination.</p>"
"documentation":"<p>Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination.</p>"
},
"DescribeDBEngineVersions":{
"name":"DescribeDBEngineVersions",
@ -392,7 +392,7 @@
"shape":"DBEngineVersionMessage",
"resultWrapper":"DescribeDBEngineVersionsResult"
},
"documentation":"<p>Returns a list of the available DB engines.</p>"
"documentation":"<p>Returns a list of the available engines.</p>"
},
"DescribeDBInstances":{
"name":"DescribeDBInstances",
@ -463,7 +463,7 @@
"shape":"EventsMessage",
"resultWrapper":"DescribeEventsResult"
},
"documentation":"<p>Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>"
"documentation":"<p>Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.</p>"
},
"DescribeOrderableDBInstanceOptions":{
"name":"DescribeOrderableDBInstanceOptions",
@ -476,7 +476,7 @@
"shape":"OrderableDBInstanceOptionsMessage",
"resultWrapper":"DescribeOrderableDBInstanceOptionsResult"
},
"documentation":"<p>Returns a list of orderable DB instance options for the specified engine.</p>"
"documentation":"<p>Returns a list of orderable instance options for the specified engine.</p>"
},
"DescribePendingMaintenanceActions":{
"name":"DescribePendingMaintenanceActions",
@ -492,7 +492,7 @@
"errors":[
{"shape":"ResourceNotFoundFault"}
],
"documentation":"<p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p>"
"documentation":"<p>Returns a list of resources (for example, instances) that have at least one pending maintenance action.</p>"
},
"FailoverDBCluster":{
"name":"FailoverDBCluster",
@ -510,7 +510,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBInstanceStateFault"}
],
"documentation":"<p>Forces a failover for a DB cluster.</p> <p>A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).</p> <p>If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.</p>"
"documentation":"<p>Forces a failover for a cluster.</p> <p>A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).</p> <p>If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -554,7 +554,7 @@
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBClusterAlreadyExistsFault"}
],
"documentation":"<p>Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </p>"
"documentation":"<p>Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. </p>"
},
"ModifyDBClusterParameterGroup":{
"name":"ModifyDBClusterParameterGroup",
@ -571,7 +571,7 @@
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"InvalidDBParameterGroupStateFault"}
],
"documentation":"<p> Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.</p> </note> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
"documentation":"<p> Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: <code>ParameterName</code>, <code>ParameterValue</code>, and <code>ApplyMethod</code>. A maximum of 20 parameters can be modified in a single request. </p> <note> <p>Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.</p> </note> <important> <p>After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
},
"ModifyDBClusterSnapshotAttribute":{
"name":"ModifyDBClusterSnapshotAttribute",
@ -589,7 +589,7 @@
{"shape":"InvalidDBClusterSnapshotStateFault"},
{"shape":"SharedSnapshotQuotaExceededFault"}
],
"documentation":"<p>Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.</p> <p>To share a manual DB cluster snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code>, and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value <code>all</code> to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case.</p>"
"documentation":"<p>Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.</p> <p>To share a manual cluster snapshot with other AWS accounts, specify <code>restore</code> as the <code>AttributeName</code>, and use the <code>ValuesToAdd</code> parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual cluster snapshot. Use the value <code>all</code> to make the manual cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the <code>ValuesToAdd</code> parameter. You can't use <code>all</code> as a value for that parameter in this case.</p>"
},
"ModifyDBInstance":{
"name":"ModifyDBInstance",
@ -617,7 +617,7 @@
{"shape":"AuthorizationNotFoundFault"},
{"shape":"CertificateNotFoundFault"}
],
"documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.</p>"
"documentation":"<p>Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.</p>"
},
"ModifyDBSubnetGroup":{
"name":"ModifyDBSubnetGroup",
@ -637,7 +637,7 @@
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"InvalidSubnet"}
],
"documentation":"<p>Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
"documentation":"<p>Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.</p>"
},
"RebootDBInstance":{
"name":"RebootDBInstance",
@ -654,7 +654,7 @@
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBInstanceNotFoundFault"}
],
"documentation":"<p>You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to <i>rebooting</i>. </p>"
"documentation":"<p>You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to <i>rebooting</i>. </p>"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
@ -685,7 +685,7 @@
{"shape":"InvalidDBParameterGroupStateFault"},
{"shape":"DBParameterGroupNotFoundFault"}
],
"documentation":"<p> Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire DB cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance reboot.</p>"
"documentation":"<p> Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: <code>ParameterName</code> and <code>ApplyMethod</code>. To reset the entire cluster parameter group, specify the <code>DBClusterParameterGroupName</code> and <code>ResetAllParameters</code> parameters. </p> <p> When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to <code>pending-reboot</code> to take effect on the next DB instance reboot.</p>"
},
"RestoreDBClusterFromSnapshot":{
"name":"RestoreDBClusterFromSnapshot",
@ -716,7 +716,7 @@
{"shape":"InvalidSubnet"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.</p> <p>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.</p>"
"documentation":"<p>Creates a new cluster from a snapshot or cluster snapshot.</p> <p>If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.</p> <p>If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.</p>"
},
"RestoreDBClusterToPointInTime":{
"name":"RestoreDBClusterToPointInTime",
@ -746,7 +746,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"StorageQuotaExceededFault"}
],
"documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. </p>"
"documentation":"<p>Restores a 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 cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group. </p>"
},
"StartDBCluster":{
"name":"StartDBCluster",
@ -851,7 +851,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified DB security group.</p> <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>",
"documentation":"<p>The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.</p> <p>Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.</p>",
"error":{
"code":"AuthorizationNotFound",
"httpStatusCode":404,
@ -961,7 +961,7 @@
"documentation":"<p>The list of log types to disable.</p>"
}
},
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster.</p> <p>The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine that is being used.</p>"
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.</p> <p>The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.</p>"
},
"CopyDBClusterParameterGroupMessage":{
"type":"structure",
@ -973,15 +973,15 @@
"members":{
"SourceDBClusterParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid DB cluster parameter group.</p> </li> <li> <p>If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>.</p> </li> </ul>"
"documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid cluster parameter group.</p> </li> <li> <p>If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>.</p> </li> </ul>"
},
"TargetDBClusterParameterGroupIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the copied DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-param-group1</code> </p>"
"documentation":"<p>The identifier for the copied cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-param-group1</code> </p>"
},
"TargetDBClusterParameterGroupDescription":{
"shape":"String",
"documentation":"<p>A description for the copied DB cluster parameter group.</p>"
"documentation":"<p>A description for the copied cluster parameter group.</p>"
},
"Tags":{
"shape":"TagList",
@ -1005,27 +1005,27 @@
"members":{
"SourceDBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive.</p> <p>You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
"documentation":"<p>The identifier of the cluster snapshot to copy. This parameter is not case sensitive.</p> <p>You can't copy an encrypted, shared cluster snapshot from one AWS Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
},
"TargetDBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot2</code> </p>"
"documentation":"<p>The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot2</code> </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. </p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. </p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted DB cluster snapshot to another AWS Region, set <code>KmsKeyId</code> to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
"documentation":"<p>The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. </p> <p>If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot. </p> <p>If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted cluster snapshot to another AWS Region, set <code>KmsKeyId</code> to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.</p> <p>If you copy an unencrypted cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
},
"PreSignedUrl":{
"shape":"String",
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying an encrypted DB cluster snapshot from another AWS Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115</code>.</p> </li> </ul>"
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying an encrypted cluster snapshot from another AWS Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The cluster snapshot identifier for the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115</code>.</p> </li> </ul>"
},
"CopyTags":{
"shape":"BooleanOptional",
"documentation":"<p>Set to <code>true</code> to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
"documentation":"<p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster snapshot.</p>"
"documentation":"<p>The tags to be assigned to the cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input to <a>CopyDBClusterSnapshot</a>.</p>"
@ -1047,7 +1047,7 @@
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.</p>"
"documentation":"<p>A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@ -1055,23 +1055,23 @@
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
"documentation":"<p>The cluster identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
},
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p> The name of the DB cluster parameter group to associate with this DB cluster.</p>"
"documentation":"<p> The name of the cluster parameter group to associate with this cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of EC2 VPC security groups to associate with this DB cluster.</p>"
"documentation":"<p>A list of EC2 VPC security groups to associate with this cluster.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>A DB subnet group to associate with this DB cluster.</p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
"documentation":"<p>A subnet group to associate with this cluster.</p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The name of the database engine to be used for this DB cluster.</p> <p>Valid values: <code>docdb</code> </p>"
"documentation":"<p>The name of the database engine to be used for this cluster.</p> <p>Valid values: <code>docdb</code> </p>"
},
"EngineVersion":{
"shape":"String",
@ -1079,11 +1079,11 @@
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the instances in the DB cluster accept connections.</p>"
"documentation":"<p>The port number on which the instances in the cluster accept connections.</p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>The name of the master user for the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 63 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine.</p> </li> </ul>"
"documentation":"<p>The name of the master user for the cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 63 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine.</p> </li> </ul>"
},
"MasterUserPassword":{
"shape":"String",
@ -1099,15 +1099,15 @@
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster.</p>"
"documentation":"<p>The tags to be assigned to the cluster.</p>"
},
"StorageEncrypted":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether the DB cluster is encrypted.</p>"
"documentation":"<p>Specifies whether the cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for an encrypted DB cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code> and <code>ReplicationSourceIdentifier</code> is not specified, Amazon DocumentDB uses your default encryption key.</p> </li> </ul> <p>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p> <p>If you create a replica of an encrypted DB cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.</p>"
"documentation":"<p>The AWS KMS key identifier for an encrypted cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code> and <code>ReplicationSourceIdentifier</code> is not specified, Amazon DocumentDB uses your default encryption key.</p> </li> </ul> <p>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p> <p>If you create a replica of an encrypted cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@ -1130,19 +1130,19 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
"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>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The DB cluster parameter group family name.</p>"
"documentation":"<p>The cluster parameter group family name.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description for the DB cluster parameter group.</p>"
"documentation":"<p>The description for the cluster parameter group.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster parameter group.</p>"
"documentation":"<p>The tags to be assigned to the cluster parameter group.</p>"
}
},
"documentation":"<p>Represents the input of <a>CreateDBClusterParameterGroup</a>.</p>"
@ -1168,15 +1168,15 @@
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
"documentation":"<p>The identifier of the cluster snapshot. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster to create a snapshot for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
"documentation":"<p>The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul> <p>Example: <code>my-cluster</code> </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB cluster snapshot.</p>"
"documentation":"<p>The tags to be assigned to the cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input of <a>CreateDBClusterSnapshot</a>.</p>"
@ -1198,11 +1198,11 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
"documentation":"<p>The instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The compute and memory capacity of the DB instance; for example, <code>db.r5.large</code>. </p>"
"documentation":"<p>The compute and memory capacity of the instance; for example, <code>db.r5.large</code>. </p>"
},
"Engine":{
"shape":"String",
@ -1210,7 +1210,7 @@
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p> The Amazon EC2 Availability Zone that the DB instance is created in.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.</p> <p> Example: <code>us-east-1d</code> </p> <p> Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the <code>MultiAZ</code> parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </p>"
"documentation":"<p> The Amazon EC2 Availability Zone that the instance is created in.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.</p> <p> Example: <code>us-east-1d</code> </p> <p> Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the <code>MultiAZ</code> parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
@ -1218,15 +1218,15 @@
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.</p> <p>Default: <code>true</code> </p>"
"documentation":"<p>Indicates that minor engine upgrades are applied automatically to the instance during the maintenance window.</p> <p>Default: <code>true</code> </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB instance. You can assign up to 10 tags to an instance.</p>"
"documentation":"<p>The tags to be assigned to the instance. You can assign up to 10 tags to an instance.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster that the instance will belong to.</p>"
"documentation":"<p>The identifier of the cluster that the instance will belong to.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
@ -1251,19 +1251,19 @@
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string.</p> <p>Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
"documentation":"<p>The name for the subnet group. This value is stored as a lowercase string.</p> <p>Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>The description for the DB subnet group.</p>"
"documentation":"<p>The description for the subnet group.</p>"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"<p>The Amazon EC2 subnet IDs for the DB subnet group.</p>"
"documentation":"<p>The Amazon EC2 subnet IDs for the subnet group.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB subnet group.</p>"
"documentation":"<p>The tags to be assigned to the subnet group.</p>"
}
},
"documentation":"<p>Represents the input to <a>CreateDBSubnetGroup</a>.</p>"
@ -1279,27 +1279,27 @@
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.</p>"
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the number of days for which automatic DB snapshots are retained.</p>"
"documentation":"<p>Specifies the number of days for which automatic snapshots are retained.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.</p>"
"documentation":"<p>Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.</p>"
},
"DBClusterParameterGroup":{
"shape":"String",
"documentation":"<p>Specifies the name of the DB cluster parameter group for the DB cluster.</p>"
"documentation":"<p>Specifies the name of the cluster parameter group for the cluster.</p>"
},
"DBSubnetGroup":{
"shape":"String",
"documentation":"<p>Specifies information on the subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.</p>"
"documentation":"<p>Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>Specifies the current state of this DB cluster.</p>"
"documentation":"<p>Specifies the current state of this cluster.</p>"
},
"PercentProgress":{
"shape":"String",
@ -1311,19 +1311,19 @@
},
"Endpoint":{
"shape":"String",
"documentation":"<p>Specifies the connection endpoint for the primary instance of the DB cluster.</p>"
"documentation":"<p>Specifies the connection endpoint for the primary instance of the cluster.</p>"
},
"ReaderEndpoint":{
"shape":"String",
"documentation":"<p>The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load balances connections across the Amazon DocumentDB replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the DB cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your DB cluster. </p> <p>If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.</p>"
"documentation":"<p>The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. </p> <p>If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.</p>"
},
"MultiAZ":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster has instances in multiple Availability Zones.</p>"
"documentation":"<p>Specifies whether the cluster has instances in multiple Availability Zones.</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Provides the name of the database engine to be used for this DB cluster.</p>"
"documentation":"<p>Provides the name of the database engine to be used for this cluster.</p>"
},
"EngineVersion":{
"shape":"String",
@ -1339,7 +1339,7 @@
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Contains the master user name for the DB cluster.</p>"
"documentation":"<p>Contains the master user name for the cluster.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -1351,11 +1351,11 @@
},
"DBClusterMembers":{
"shape":"DBClusterMemberList",
"documentation":"<p>Provides the list of instances that make up the DB cluster.</p>"
"documentation":"<p>Provides the list of instances that make up the cluster.</p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"<p>Provides a list of virtual private cloud (VPC) security groups that the DB cluster belongs to.</p>"
"documentation":"<p>Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.</p>"
},
"HostedZoneId":{
"shape":"String",
@ -1363,45 +1363,45 @@
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster is encrypted.</p>"
"documentation":"<p>Specifies whether the cluster is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB cluster.</p>"
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted cluster.</p>"
},
"DbClusterResourceId":{
"shape":"String",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.</p>"
"documentation":"<p>The AWS Region-unique, immutable identifier for the cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is accessed.</p>"
},
"DBClusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the cluster.</p>"
},
"AssociatedRoles":{
"shape":"DBClusterRoles",
"documentation":"<p>Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.</p>"
"documentation":"<p>Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the cluster. IAM roles that are associated with a cluster grant permission for the cluster to access other AWS services on your behalf.</p>"
},
"ClusterCreateTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"
"documentation":"<p>Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs.</p>"
"documentation":"<p>A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.</p>"
},
"DeletionProtection":{
"shape":"Boolean",
"documentation":"<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster. </p>",
"documentation":"<p>Detailed information about a cluster. </p>",
"wrapper":true
},
"DBClusterAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB cluster with the given identifier.</p>",
"documentation":"<p>You already have a cluster with the given identifier.</p>",
"error":{
"code":"DBClusterAlreadyExistsFault",
"httpStatusCode":400,
@ -1421,22 +1421,22 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the instance identifier for this member of the DB cluster.</p>"
"documentation":"<p>Specifies the instance identifier for this member of the cluster.</p>"
},
"IsClusterWriter":{
"shape":"Boolean",
"documentation":"<p>A value that is <code>true</code> if the cluster member is the primary instance for the DB cluster and <code>false</code> otherwise.</p>"
"documentation":"<p>A value that is <code>true</code> if the cluster member is the primary instance for the cluster and <code>false</code> otherwise.</p>"
},
"DBClusterParameterGroupStatus":{
"shape":"String",
"documentation":"<p>Specifies the status of the DB cluster parameter group for this member of the DB cluster.</p>"
"documentation":"<p>Specifies the status of the cluster parameter group for this member of the DB cluster.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance. </p>"
}
},
"documentation":"<p>Contains information about an instance that is part of a DB cluster.</p>",
"documentation":"<p>Contains information about an instance that is part of a cluster.</p>",
"wrapper":true
},
"DBClusterMemberList":{
@ -1455,7 +1455,7 @@
},
"DBClusters":{
"shape":"DBClusterList",
"documentation":"<p>A list of DB clusters.</p>"
"documentation":"<p>A list of clusters.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBClusters</a>.</p>"
@ -1464,7 +1464,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster. </p>",
"documentation":"<p> <code>DBClusterIdentifier</code> doesn't refer to an existing cluster. </p>",
"error":{
"code":"DBClusterNotFoundFault",
"httpStatusCode":404,
@ -1477,22 +1477,22 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>Provides the name of the DB cluster parameter group.</p>"
"documentation":"<p>Provides the name of the cluster parameter group.</p>"
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.</p>"
"documentation":"<p>Provides the name of the parameter group family that this cluster parameter group is compatible with.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>Provides the customer-specified description for this DB cluster parameter group.</p>"
"documentation":"<p>Provides the customer-specified description for this cluster parameter group.</p>"
},
"DBClusterParameterGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster parameter group.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the cluster parameter group.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster parameter group. </p>",
"documentation":"<p>Detailed information about a cluster parameter group. </p>",
"wrapper":true
},
"DBClusterParameterGroupDetails":{
@ -1500,7 +1500,7 @@
"members":{
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>Provides a list of parameters for the DB cluster parameter group.</p>"
"documentation":"<p>Provides a list of parameters for the cluster parameter group.</p>"
},
"Marker":{
"shape":"String",
@ -1521,16 +1521,16 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
"documentation":"<p>The name of a cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
}
},
"documentation":"<p>Contains the name of a DB cluster parameter group.</p>"
"documentation":"<p>Contains the name of a cluster parameter group.</p>"
},
"DBClusterParameterGroupNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB cluster parameter group. </p>",
"documentation":"<p> <code>DBClusterParameterGroupName</code> doesn't refer to an existing cluster parameter group. </p>",
"error":{
"code":"DBClusterParameterGroupNotFound",
"httpStatusCode":404,
@ -1547,7 +1547,7 @@
},
"DBClusterParameterGroups":{
"shape":"DBClusterParameterGroupList",
"documentation":"<p>A list of DB cluster parameter groups.</p>"
"documentation":"<p>A list of cluster parameter groups.</p>"
}
},
"documentation":"<p>Represents the output of <a>DBClusterParameterGroups</a>.</p>"
@ -1556,7 +1556,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster can't be created because you have reached the maximum allowed quota of DB clusters.</p>",
"documentation":"<p>The cluster can't be created because you have reached the maximum allowed quota of clusters.</p>",
"error":{
"code":"DBClusterQuotaExceededFault",
"httpStatusCode":403,
@ -1573,10 +1573,10 @@
},
"Status":{
"shape":"String",
"documentation":"<p>Describes the state of association between the IAM role and the DB cluster. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - The IAM role ARN is being associated with the DB cluster.</p> </li> <li> <p> <code>INVALID</code> - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the IAM role to access other AWS services on your behalf.</p> </li> </ul>"
"documentation":"<p>Describes the state of association between the IAM role and the cluster. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - The IAM role ARN is associated with the cluster and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - The IAM role ARN is being associated with the DB cluster.</p> </li> <li> <p> <code>INVALID</code> - The IAM role ARN is associated with the cluster, but the cluster cannot assume the IAM role to access other AWS services on your behalf.</p> </li> </ul>"
}
},
"documentation":"<p>Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.</p>"
"documentation":"<p>Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.</p>"
},
"DBClusterRoles":{
"type":"list",
@ -1590,15 +1590,15 @@
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.</p>"
"documentation":"<p>Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.</p>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the identifier for the DB cluster snapshot.</p>"
"documentation":"<p>Specifies the identifier for the cluster snapshot.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.</p>"
"documentation":"<p>Specifies the cluster identifier of the cluster that this cluster snapshot was created from.</p>"
},
"SnapshotCreateTime":{
"shape":"TStamp",
@ -1610,31 +1610,31 @@
},
"Status":{
"shape":"String",
"documentation":"<p>Specifies the status of this DB cluster snapshot.</p>"
"documentation":"<p>Specifies the status of this cluster snapshot.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the DB cluster was listening on at the time of the snapshot.</p>"
"documentation":"<p>Specifies the port that the cluster was listening on at the time of the snapshot.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.</p>"
"documentation":"<p>Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.</p>"
},
"ClusterCreateTime":{
"shape":"TStamp",
"documentation":"<p>Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).</p>"
"documentation":"<p>Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).</p>"
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Provides the master user name for the DB cluster snapshot.</p>"
"documentation":"<p>Provides the master user name for the cluster snapshot.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>Provides the version of the database engine for this DB cluster snapshot.</p>"
"documentation":"<p>Provides the version of the database engine for this cluster snapshot.</p>"
},
"SnapshotType":{
"shape":"String",
"documentation":"<p>Provides the type of the DB cluster snapshot.</p>"
"documentation":"<p>Provides the type of the cluster snapshot.</p>"
},
"PercentProgress":{
"shape":"Integer",
@ -1642,29 +1642,29 @@
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB cluster snapshot is encrypted.</p>"
"documentation":"<p>Specifies whether the cluster snapshot is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB cluster snapshot.</p>"
"documentation":"<p>If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted cluster snapshot.</p>"
},
"DBClusterSnapshotArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB cluster snapshot.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the cluster snapshot.</p>"
},
"SourceDBClusterSnapshotArn":{
"shape":"String",
"documentation":"<p>If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value.</p>"
"documentation":"<p>If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.</p>"
}
},
"documentation":"<p>Detailed information about a DB cluster snapshot. </p>",
"documentation":"<p>Detailed information about a cluster snapshot. </p>",
"wrapper":true
},
"DBClusterSnapshotAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB cluster snapshot with the given identifier.</p>",
"documentation":"<p>You already have a cluster snapshot with the given identifier.</p>",
"error":{
"code":"DBClusterSnapshotAlreadyExistsFault",
"httpStatusCode":400,
@ -1677,14 +1677,14 @@
"members":{
"AttributeName":{
"shape":"String",
"documentation":"<p>The name of the manual DB cluster snapshot attribute.</p> <p>The attribute named <code>restore</code> refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot.</p>"
"documentation":"<p>The name of the manual cluster snapshot attribute.</p> <p>The attribute named <code>restore</code> refers to the list of AWS accounts that have permission to copy or restore the manual cluster snapshot.</p>"
},
"AttributeValues":{
"shape":"AttributeValueList",
"documentation":"<p>The values for the manual DB cluster snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of <code>all</code> is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.</p>"
"documentation":"<p>The values for the manual cluster snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If a value of <code>all</code> is in the list, then the manual cluster snapshot is public and available for any AWS account to copy or restore.</p>"
}
},
"documentation":"<p>Contains the name and values of a manual DB cluster snapshot attribute.</p> <p>Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot.</p>"
"documentation":"<p>Contains the name and values of a manual cluster snapshot attribute.</p> <p>Manual cluster snapshot attributes are used to authorize other AWS accounts to restore a manual cluster snapshot.</p>"
},
"DBClusterSnapshotAttributeList":{
"type":"list",
@ -1698,14 +1698,14 @@
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot that the attributes apply to.</p>"
"documentation":"<p>The identifier of the cluster snapshot that the attributes apply to.</p>"
},
"DBClusterSnapshotAttributes":{
"shape":"DBClusterSnapshotAttributeList",
"documentation":"<p>The list of attributes and values for the DB cluster snapshot.</p>"
"documentation":"<p>The list of attributes and values for the cluster snapshot.</p>"
}
},
"documentation":"<p>Detailed information about the attributes that are associated with a DB cluster snapshot.</p>",
"documentation":"<p>Detailed information about the attributes that are associated with a cluster snapshot.</p>",
"wrapper":true
},
"DBClusterSnapshotList":{
@ -1724,7 +1724,7 @@
},
"DBClusterSnapshots":{
"shape":"DBClusterSnapshotList",
"documentation":"<p>Provides a list of DB cluster snapshots.</p>"
"documentation":"<p>Provides a list of cluster snapshots.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBClusterSnapshots</a>.</p>"
@ -1733,7 +1733,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot. </p>",
"documentation":"<p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot. </p>",
"error":{
"code":"DBClusterSnapshotNotFoundFault",
"httpStatusCode":404,
@ -1754,7 +1754,7 @@
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group family for the database engine.</p>"
"documentation":"<p>The name of the parameter group family for the database engine.</p>"
},
"DBEngineDescription":{
"shape":"String",
@ -1777,7 +1777,7 @@
"documentation":"<p>A value that indicates whether the engine version supports exporting the log types specified by <code>ExportableLogTypes</code> to CloudWatch Logs.</p>"
}
},
"documentation":"<p> Detailed information about a DB engine version. </p>"
"documentation":"<p> Detailed information about an engine version. </p>"
},
"DBEngineVersionList":{
"type":"list",
@ -1795,7 +1795,7 @@
},
"DBEngineVersions":{
"shape":"DBEngineVersionList",
"documentation":"<p>Detailed information about one or more DB engine versions.</p>"
"documentation":"<p>Detailed information about one or more engine versions.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBEngineVersions</a>.</p>"
@ -1805,15 +1805,15 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>Contains a user-provided database identifier. This identifier is the unique key that identifies a DB instance.</p>"
"documentation":"<p>Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>Contains the name of the compute and memory capacity class of the DB instance.</p>"
"documentation":"<p>Contains the name of the compute and memory capacity class of the instance.</p>"
},
"Engine":{
"shape":"String",
"documentation":"<p>Provides the name of the database engine to be used for this DB instance.</p>"
"documentation":"<p>Provides the name of the database engine to be used for this instance.</p>"
},
"DBInstanceStatus":{
"shape":"String",
@ -1825,7 +1825,7 @@
},
"InstanceCreateTime":{
"shape":"TStamp",
"documentation":"<p>Provides the date and time that the DB instance was created.</p>"
"documentation":"<p>Provides the date and time that the instance was created.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -1833,19 +1833,19 @@
},
"BackupRetentionPeriod":{
"shape":"Integer",
"documentation":"<p>Specifies the number of days for which automatic DB snapshots are retained.</p>"
"documentation":"<p>Specifies the number of days for which automatic snapshots are retained.</p>"
},
"VpcSecurityGroups":{
"shape":"VpcSecurityGroupMembershipList",
"documentation":"<p>Provides a list of VPC security group elements that the DB instance belongs to.</p>"
"documentation":"<p>Provides a list of VPC security group elements that the instance belongs to.</p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>Specifies the name of the Availability Zone that the DB instance is located in.</p>"
"documentation":"<p>Specifies the name of the Availability Zone that the instance is located in.</p>"
},
"DBSubnetGroup":{
"shape":"DBSubnetGroup",
"documentation":"<p>Specifies information on the subnet group that is associated with the DB instance, including the name, description, and subnets in the subnet group.</p>"
"documentation":"<p>Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
@ -1853,7 +1853,7 @@
},
"PendingModifiedValues":{
"shape":"PendingModifiedValues",
"documentation":"<p>Specifies that changes to the DB instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.</p>"
"documentation":"<p>Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.</p>"
},
"LatestRestorableTime":{
"shape":"TStamp",
@ -1877,19 +1877,19 @@
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB cluster.</p>"
"documentation":"<p>Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.</p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether or not the DB instance is encrypted.</p>"
"documentation":"<p>Specifies whether or not the instance is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p> If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted DB instance. </p>"
"documentation":"<p> If <code>StorageEncrypted</code> is <code>true</code>, the AWS KMS key identifier for the encrypted instance. </p>"
},
"DbiResourceId":{
"shape":"String",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.</p>"
"documentation":"<p>The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.</p>"
},
"CACertificateIdentifier":{
"shape":"String",
@ -1901,21 +1901,21 @@
},
"DBInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB instance.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the instance.</p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs.</p>"
"documentation":"<p>A list of log types that this instance is configured to export to Amazon CloudWatch Logs.</p>"
}
},
"documentation":"<p>Detailed information about a DB instance. </p>",
"documentation":"<p>Detailed information about an instance. </p>",
"wrapper":true
},
"DBInstanceAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You already have a DB instance with the given identifier.</p>",
"documentation":"<p>You already have a instance with the given identifier.</p>",
"error":{
"code":"DBInstanceAlreadyExists",
"httpStatusCode":400,
@ -1939,7 +1939,7 @@
},
"DBInstances":{
"shape":"DBInstanceList",
"documentation":"<p>Detailed information about one or more DB instances. </p>"
"documentation":"<p>Detailed information about one or more instances. </p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBInstances</a>.</p>"
@ -1948,7 +1948,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance. </p>",
"documentation":"<p> <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>",
"error":{
"code":"DBInstanceNotFound",
"httpStatusCode":404,
@ -1969,14 +1969,14 @@
},
"Status":{
"shape":"String",
"documentation":"<p>Status of the DB instance. For a <code>StatusType</code> of read replica, the values can be <code>replicating</code>, error, <code>stopped</code>, or <code>terminated</code>.</p>"
"documentation":"<p>Status of the instance. For a <code>StatusType</code> of read replica, the values can be <code>replicating</code>, error, <code>stopped</code>, or <code>terminated</code>.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.</p>"
}
},
"documentation":"<p>Provides a list of status information for a DB instance.</p>"
"documentation":"<p>Provides a list of status information for an instance.</p>"
},
"DBInstanceStatusInfoList":{
"type":"list",
@ -1989,7 +1989,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>A DB parameter group with the same name already exists.</p>",
"documentation":"<p>A parameter group with the same name already exists.</p>",
"error":{
"code":"DBParameterGroupAlreadyExists",
"httpStatusCode":400,
@ -2001,7 +2001,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group. </p>",
"documentation":"<p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>",
"error":{
"code":"DBParameterGroupNotFound",
"httpStatusCode":404,
@ -2013,7 +2013,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>This request would cause you to exceed the allowed number of DB parameter groups.</p>",
"documentation":"<p>This request would cause you to exceed the allowed number of parameter groups.</p>",
"error":{
"code":"DBParameterGroupQuotaExceeded",
"httpStatusCode":400,
@ -2025,7 +2025,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group. </p>",
"documentation":"<p> <code>DBSecurityGroupName</code> doesn't refer to an existing security group. </p>",
"error":{
"code":"DBSecurityGroupNotFound",
"httpStatusCode":404,
@ -2049,7 +2049,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot. </p>",
"documentation":"<p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing snapshot. </p>",
"error":{
"code":"DBSnapshotNotFound",
"httpStatusCode":404,
@ -2062,37 +2062,37 @@
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group.</p>"
"documentation":"<p>The name of the subnet group.</p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>Provides the description of the DB subnet group.</p>"
"documentation":"<p>Provides the description of the subnet group.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the virtual private cloud (VPC) ID of the DB subnet group.</p>"
"documentation":"<p>Provides the virtual private cloud (VPC) ID of the subnet group.</p>"
},
"SubnetGroupStatus":{
"shape":"String",
"documentation":"<p>Provides the status of the DB subnet group.</p>"
"documentation":"<p>Provides the status of the subnet group.</p>"
},
"Subnets":{
"shape":"SubnetList",
"documentation":"<p>Detailed information about one or more subnets within a DB subnet group.</p>"
"documentation":"<p>Detailed information about one or more subnets within a subnet group.</p>"
},
"DBSubnetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"
}
},
"documentation":"<p>Detailed information about a DB subnet group. </p>",
"documentation":"<p>Detailed information about a subnet group. </p>",
"wrapper":true
},
"DBSubnetGroupAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSubnetGroupName</code> is already being used by an existing DB subnet group. </p>",
"documentation":"<p> <code>DBSubnetGroupName</code> is already being used by an existing subnet group. </p>",
"error":{
"code":"DBSubnetGroupAlreadyExists",
"httpStatusCode":400,
@ -2104,7 +2104,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>",
"documentation":"<p>Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>",
"error":{
"code":"DBSubnetGroupDoesNotCoverEnoughAZs",
"httpStatusCode":400,
@ -2121,7 +2121,7 @@
},
"DBSubnetGroups":{
"shape":"DBSubnetGroups",
"documentation":"<p>Detailed information about one or more DB subnet groups.</p>"
"documentation":"<p>Detailed information about one or more subnet groups.</p>"
}
},
"documentation":"<p>Represents the output of <a>DescribeDBSubnetGroups</a>.</p>"
@ -2130,7 +2130,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group. </p>",
"documentation":"<p> <code>DBSubnetGroupName</code> doesn't refer to an existing subnet group. </p>",
"error":{
"code":"DBSubnetGroupNotFoundFault",
"httpStatusCode":404,
@ -2142,7 +2142,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB subnet groups.</p>",
"documentation":"<p>The request would cause you to exceed the allowed number of subnet groups.</p>",
"error":{
"code":"DBSubnetGroupQuotaExceeded",
"httpStatusCode":400,
@ -2161,7 +2161,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of subnets in a DB subnet group.</p>",
"documentation":"<p>The request would cause you to exceed the allowed number of subnets in a subnet group.</p>",
"error":{
"code":"DBSubnetQuotaExceededFault",
"httpStatusCode":400,
@ -2173,7 +2173,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB upgrade failed because a resource that the DB depends on can't be modified.</p>",
"documentation":"<p>The upgrade failed because a resource that the depends on can't be modified.</p>",
"error":{
"code":"DBUpgradeDependencyFailure",
"httpStatusCode":400,
@ -2187,15 +2187,15 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
"documentation":"<p>The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
},
"SkipFinalSnapshot":{
"shape":"Boolean",
"documentation":"<p> Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If <code>true</code> is specified, no DB cluster snapshot is created. If <code>false</code> is specified, a DB cluster snapshot is created before the DB cluster is deleted. </p> <note> <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note> <p>Default: <code>false</code> </p>"
"documentation":"<p> Determines whether a final cluster snapshot is created before the cluster is deleted. If <code>true</code> is specified, no cluster snapshot is created. If <code>false</code> is specified, a cluster snapshot is created before the DB cluster is deleted. </p> <note> <p>If <code>SkipFinalSnapshot</code> is <code>false</code>, you must specify a <code>FinalDBSnapshotIdentifier</code> parameter.</p> </note> <p>Default: <code>false</code> </p>"
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
"documentation":"<p> The DB cluster snapshot identifier of the new DB cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. </p> <note> <p> Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to <code>true</code> results in an error. </p> </note> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p> The cluster snapshot identifier of the new cluster snapshot created when <code>SkipFinalSnapshot</code> is set to <code>false</code>. </p> <note> <p> Specifying this parameter and also setting the <code>SkipFinalShapshot</code> parameter to <code>true</code> results in an error. </p> </note> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBCluster</a>.</p>"
@ -2206,7 +2206,7 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing DB cluster parameter group.</p> </li> <li> <p>You can't delete a default DB cluster parameter group.</p> </li> <li> <p>Cannot be associated with any DB clusters.</p> </li> </ul>"
"documentation":"<p>The name of the cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must be the name of an existing cluster parameter group.</p> </li> <li> <p>You can't delete a default cluster parameter group.</p> </li> <li> <p>Cannot be associated with any clusters.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBClusterParameterGroup</a>.</p>"
@ -2223,7 +2223,7 @@
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the DB cluster snapshot to delete.</p> <p>Constraints: Must be the name of an existing DB cluster snapshot in the <code>available</code> state.</p>"
"documentation":"<p>The identifier of the cluster snapshot to delete.</p> <p>Constraints: Must be the name of an existing cluster snapshot in the <code>available</code> state.</p>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBClusterSnapshot</a>.</p>"
@ -2240,7 +2240,7 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing DB instance.</p> </li> </ul>"
"documentation":"<p>The instance identifier for the instance to be deleted. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing instance.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the input to <a>DeleteDBInstance</a>.</p>"
@ -2288,7 +2288,7 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB cluster parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
"documentation":"<p>The name of a specific cluster parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
@ -2311,7 +2311,7 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of a specific DB cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
"documentation":"<p>The name of a specific cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>"
},
"Source":{
"shape":"String",
@ -2338,7 +2338,7 @@
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB cluster snapshot to describe the attributes for.</p>"
"documentation":"<p>The identifier for the cluster snapshot to describe the attributes for.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterSnapshotAttributes</a>.</p>"
@ -2354,15 +2354,15 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
"documentation":"<p>The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the <code>DBClusterSnapshotIdentifier</code> parameter. This parameter is not case sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>A specific DB cluster snapshot identifier to describe. This parameter can't be used with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBClusterSnapshot</code>.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
"documentation":"<p>A specific cluster snapshot identifier to describe. This parameter can't be used with the <code>DBClusterIdentifier</code> parameter. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBClusterSnapshot</code>.</p> </li> <li> <p>If this identifier is for an automated snapshot, the <code>SnapshotType</code> parameter must also be specified.</p> </li> </ul>"
},
"SnapshotType":{
"shape":"String",
"documentation":"<p>The type of DB cluster snapshots to be returned. You can specify one of the following values:</p> <ul> <li> <p> <code>automated</code> - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.</p> </li> <li> <p> <code>manual</code> - Return all DB cluster snapshots that you have manually created for your AWS account.</p> </li> <li> <p> <code>shared</code> - Return all manual DB cluster snapshots that have been shared to your AWS account.</p> </li> <li> <p> <code>public</code> - Return all DB cluster snapshots that have been marked as public.</p> </li> </ul> <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public DB cluster snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>.</p> <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>"
"documentation":"<p>The type of cluster snapshots to be returned. You can specify one of the following values:</p> <ul> <li> <p> <code>automated</code> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.</p> </li> <li> <p> <code>manual</code> - Return all cluster snapshots that you have manually created for your AWS account.</p> </li> <li> <p> <code>shared</code> - Return all manual cluster snapshots that have been shared to your AWS account.</p> </li> <li> <p> <code>public</code> - Return all cluster snapshots that have been marked as public.</p> </li> </ul> <p>If you don't specify a <code>SnapshotType</code> value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the <code>IncludeShared</code> parameter to <code>true</code>. You can include public cluster snapshots with these results by setting the <code>IncludePublic</code> parameter to <code>true</code>.</p> <p>The <code>IncludeShared</code> and <code>IncludePublic</code> parameters don't apply for <code>SnapshotType</code> values of <code>manual</code> or <code>automated</code>. The <code>IncludePublic</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>shared</code>. The <code>IncludeShared</code> parameter doesn't apply when <code>SnapshotType</code> is set to <code>public</code>.</p>"
},
"Filters":{
"shape":"FilterList",
@ -2378,11 +2378,11 @@
},
"IncludeShared":{
"shape":"Boolean",
"documentation":"<p>Set to <code>true</code> to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
"documentation":"<p>Set to <code>true</code> to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
},
"IncludePublic":{
"shape":"Boolean",
"documentation":"<p>Set to <code>true</code> to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
"documentation":"<p>Set to <code>true</code> to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise <code>false</code>. The default is <code>false</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>DescribeDBClusterSnapshots</a>.</p>"
@ -2392,11 +2392,11 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The user-provided DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
"documentation":"<p>The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBClusterIdentifier</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.</p> </li> </ul>"
"documentation":"<p>A filter that specifies one or more clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -2422,7 +2422,7 @@
},
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of a specific DB parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBParameterGroupFamily</code>.</p> </li> </ul>"
"documentation":"<p>The name of a specific parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match an existing <code>DBParameterGroupFamily</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
@ -2456,11 +2456,11 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The user-provided instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
"documentation":"<p>The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only the information about the DB instances that are associated with the DB clusters that are identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list includes only the information about the DB instances that are identified by these ARNs.</p> </li> </ul>"
"documentation":"<p>A filter that specifies one or more instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -2478,7 +2478,7 @@
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group to return details for.</p>"
"documentation":"<p>The name of the subnet group to return details for.</p>"
},
"Filters":{
"shape":"FilterList",
@ -2501,7 +2501,7 @@
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group family to return the engine parameter information for.</p>"
"documentation":"<p>The name of the cluster parameter group family to return the engine parameter information for.</p>"
},
"Filters":{
"shape":"FilterList",
@ -2586,7 +2586,7 @@
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The name of the engine to retrieve DB instance options for.</p>"
"documentation":"<p>The name of the engine to retrieve instance options for.</p>"
},
"EngineVersion":{
"shape":"String",
@ -2594,7 +2594,7 @@
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The DB instance class filter value. Specify this parameter to show only the available offerings that match the specified DB instance class.</p>"
"documentation":"<p>The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.</p>"
},
"LicenseModel":{
"shape":"String",
@ -2628,7 +2628,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
"documentation":"<p>A filter that specifies one or more resources to return pending maintenance actions for.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.</p> </li> </ul>"
},
"Marker":{
"shape":"String",
@ -2646,7 +2646,7 @@
"members":{
"Address":{
"shape":"String",
"documentation":"<p>Specifies the DNS address of the DB instance.</p>"
"documentation":"<p>Specifies the DNS address of the instance.</p>"
},
"Port":{
"shape":"Integer",
@ -2657,14 +2657,14 @@
"documentation":"<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"
}
},
"documentation":"<p>Network information for accessing a DB cluster or DB instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.</p>"
"documentation":"<p>Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.</p>"
},
"EngineDefaults":{
"type":"structure",
"members":{
"DBParameterGroupFamily":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group family to return the engine parameter information for.</p>"
"documentation":"<p>The name of the cluster parameter group family to return the engine parameter information for.</p>"
},
"Marker":{
"shape":"String",
@ -2672,7 +2672,7 @@
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>The parameters of a particular DB cluster parameter group family.</p>"
"documentation":"<p>The parameters of a particular cluster parameter group family.</p>"
}
},
"documentation":"<p>Contains the result of a successful invocation of the <code>DescribeEngineDefaultClusterParameters</code> operation. </p>",
@ -2773,11 +2773,11 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>A DB cluster identifier to force a failover for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
"documentation":"<p>A cluster identifier to force a failover for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"TargetDBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The name of the instance to promote to the primary instance.</p> <p>You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example, <code>mydbcluster-replica1</code>.</p>"
"documentation":"<p>The name of the instance to promote to the primary instance.</p> <p>You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, <code>mydbcluster-replica1</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>FailoverDBCluster</a>.</p>"
@ -2824,7 +2824,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB instances.</p>",
"documentation":"<p>The request would cause you to exceed the allowed number of instances.</p>",
"error":{
"code":"InstanceQuotaExceeded",
"httpStatusCode":400,
@ -2836,7 +2836,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster doesn't have enough capacity for the current operation.</p>",
"documentation":"<p>The cluster doesn't have enough capacity for the current operation.</p>",
"error":{
"code":"InsufficientDBClusterCapacityFault",
"httpStatusCode":403,
@ -2848,7 +2848,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified DB instance class isn't available in the specified Availability Zone.</p>",
"documentation":"<p>The specified instance class isn't available in the specified Availability Zone.</p>",
"error":{
"code":"InsufficientDBInstanceCapacity",
"httpStatusCode":400,
@ -2874,7 +2874,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The provided value isn't a valid DB cluster snapshot state.</p>",
"documentation":"<p>The provided value isn't a valid cluster snapshot state.</p>",
"error":{
"code":"InvalidDBClusterSnapshotStateFault",
"httpStatusCode":400,
@ -2886,7 +2886,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB cluster isn't in a valid state.</p>",
"documentation":"<p>The cluster isn't in a valid state.</p>",
"error":{
"code":"InvalidDBClusterStateFault",
"httpStatusCode":400,
@ -2898,7 +2898,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> The specified DB instance isn't in the <i>available</i> state. </p>",
"documentation":"<p> The specified instance isn't in the <i>available</i> state. </p>",
"error":{
"code":"InvalidDBInstanceState",
"httpStatusCode":400,
@ -2910,7 +2910,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>",
"documentation":"<p>The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>",
"error":{
"code":"InvalidDBParameterGroupState",
"httpStatusCode":400,
@ -2922,7 +2922,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The state of the DB security group doesn't allow deletion.</p>",
"documentation":"<p>The state of the security group doesn't allow deletion.</p>",
"error":{
"code":"InvalidDBSecurityGroupState",
"httpStatusCode":400,
@ -2934,7 +2934,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The state of the DB snapshot doesn't allow deletion.</p>",
"documentation":"<p>The state of the snapshot doesn't allow deletion.</p>",
"error":{
"code":"InvalidDBSnapshotState",
"httpStatusCode":400,
@ -2946,7 +2946,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet group can't be deleted because it's in use.</p>",
"documentation":"<p>The subnet group can't be deleted because it's in use.</p>",
"error":{
"code":"InvalidDBSubnetGroupStateFault",
"httpStatusCode":400,
@ -2958,7 +2958,7 @@
"type":"structure",
"members":{
},
"documentation":"<p> The DB subnet isn't in the <i>available</i> state. </p>",
"documentation":"<p> The subnet isn't in the <i>available</i> state. </p>",
"error":{
"code":"InvalidDBSubnetStateFault",
"httpStatusCode":400,
@ -2994,7 +2994,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet group doesn't cover all Availability Zones after it is created because of changes that were made.</p>",
"documentation":"<p>The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.</p>",
"error":{
"code":"InvalidVPCNetworkStateFault",
"httpStatusCode":400,
@ -3043,15 +3043,15 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
"documentation":"<p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"NewDBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"
"documentation":"<p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-cluster2</code> </p>"
},
"ApplyImmediately":{
"shape":"Boolean",
"documentation":"<p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>Default: <code>false</code> </p>"
"documentation":"<p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p> <p>Default: <code>false</code> </p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@ -3059,15 +3059,15 @@
},
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to use for the DB cluster.</p>"
"documentation":"<p>The name of the cluster parameter group to use for the cluster.</p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.</p>"
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The same port as the original DB cluster.</p>"
"documentation":"<p>The port number on which the cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The same port as the original cluster.</p>"
},
"MasterUserPassword":{
"shape":"String",
@ -3083,7 +3083,7 @@
},
"CloudwatchLogsExportConfiguration":{
"shape":"CloudwatchLogsExportConfiguration",
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>"
"documentation":"<p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>"
},
"EngineVersion":{
"shape":"String",
@ -3105,11 +3105,11 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to modify.</p>"
"documentation":"<p>The name of the cluster parameter group to modify.</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>A list of parameters in the DB cluster parameter group to modify.</p>"
"documentation":"<p>A list of parameters in the cluster parameter group to modify.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBClusterParameterGroup</a>.</p>"
@ -3129,19 +3129,19 @@
"members":{
"DBClusterSnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB cluster snapshot to modify the attributes for.</p>"
"documentation":"<p>The identifier for the cluster snapshot to modify the attributes for.</p>"
},
"AttributeName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster snapshot attribute to modify.</p> <p>To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to <code>restore</code>.</p>"
"documentation":"<p>The name of the cluster snapshot attribute to modify.</p> <p>To manage authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this value to <code>restore</code>.</p>"
},
"ValuesToAdd":{
"shape":"AttributeValueList",
"documentation":"<p>A list of DB cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p> <p>To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to <code>all</code>. Do not add the <code>all</code> value for any manual DB cluster snapshots that contain private information that you don't want to be available to all AWS accounts.</p>"
"documentation":"<p>A list of cluster snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p> <p>To authorize other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account IDs. To make the manual cluster snapshot restorable by any AWS account, set it to <code>all</code>. Do not add the <code>all</code> value for any manual cluster snapshots that contain private information that you don't want to be available to all AWS accounts.</p>"
},
"ValuesToRemove":{
"shape":"AttributeValueList",
"documentation":"<p>A list of DB cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p> <p>To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the DB cluster snapshot, set it to <code>all</code> . If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual DB cluster snapshot.</p>"
"documentation":"<p>A list of cluster snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p> <p>To remove authorization for other AWS accounts to copy or restore a manual cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the cluster snapshot, set it to <code>all</code> . If you specify <code>all</code>, an AWS account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore a manual cluster snapshot.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBClusterSnapshotAttribute</a>.</p>"
@ -3158,27 +3158,27 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
"documentation":"<p>The instance identifier. This value is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The new compute and memory capacity of the DB instance; for example, <code>db.r5.large</code>. Not all DB instance classes are available in all AWS Regions. </p> <p>If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. </p> <p>Default: Uses existing setting.</p>"
"documentation":"<p>The new compute and memory capacity of the instance; for example, <code>db.r5.large</code>. Not all instance classes are available in all AWS Regions. </p> <p>If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless <code>ApplyImmediately</code> is specified as <code>true</code> for this request. </p> <p>Default: Uses existing setting.</p>"
},
"ApplyImmediately":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB instance. </p> <p> If this parameter is set to <code>false</code>, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.</p> <p>Default: <code>false</code> </p>"
"documentation":"<p>Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the instance. </p> <p> If this parameter is set to <code>false</code>, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.</p> <p>Default: <code>false</code> </p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.</p> <p>Default: Uses existing setting.</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Must be at least 30 minutes.</p>"
"documentation":"<p>The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.</p> <p>Default: Uses existing setting.</p> <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p>Constraints: Must be at least 30 minutes.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version. </p>"
"documentation":"<p>Indicates that minor version upgrades are applied automatically to the instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version. </p>"
},
"NewDBInstanceIdentifier":{
"shape":"String",
"documentation":"<p> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you set <code>Apply Immediately</code> to <code>true</code>. It occurs during the next maintenance window if you set <code>Apply Immediately</code> to <code>false</code>. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
"documentation":"<p> The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set <code>Apply Immediately</code> to <code>true</code>. It occurs during the next maintenance window if you set <code>Apply Immediately</code> to <code>false</code>. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"CACertificateIdentifier":{
"shape":"String",
@ -3206,15 +3206,15 @@
"members":{
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. </p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
"documentation":"<p>The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. </p> <p>Constraints: Must match the name of an existing <code>DBSubnetGroup</code>. Must not be default.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"DBSubnetGroupDescription":{
"shape":"String",
"documentation":"<p>The description for the DB subnet group.</p>"
"documentation":"<p>The description for the subnet group.</p>"
},
"SubnetIds":{
"shape":"SubnetIdentifierList",
"documentation":"<p>The Amazon EC2 subnet IDs for the DB subnet group.</p>"
"documentation":"<p>The Amazon EC2 subnet IDs for the subnet group.</p>"
}
},
"documentation":"<p>Represents the input to <a>ModifyDBSubnetGroup</a>.</p>"
@ -3230,30 +3230,30 @@
"members":{
"Engine":{
"shape":"String",
"documentation":"<p>The engine type of a DB instance.</p>"
"documentation":"<p>The engine type of an instance.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The engine version of a DB instance.</p>"
"documentation":"<p>The engine version of an instance.</p>"
},
"DBInstanceClass":{
"shape":"String",
"documentation":"<p>The DB instance class for a DB instance.</p>"
"documentation":"<p>The instance class for an instance.</p>"
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>The license model for a DB instance.</p>"
"documentation":"<p>The license model for an instance.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZoneList",
"documentation":"<p>A list of Availability Zones for a DB instance.</p>"
"documentation":"<p>A list of Availability Zones for an instance.</p>"
},
"Vpc":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a DB instance is in a virtual private cloud (VPC).</p>"
"documentation":"<p>Indicates whether an instance is in a virtual private cloud (VPC).</p>"
}
},
"documentation":"<p>The options that are available for a DB instance.</p>",
"documentation":"<p>The options that are available for an instance.</p>",
"wrapper":true
},
"OrderableDBInstanceOptionsList":{
@ -3268,7 +3268,7 @@
"members":{
"OrderableDBInstanceOptions":{
"shape":"OrderableDBInstanceOptionsList",
"documentation":"<p>The options that are available for a particular orderable DB instance.</p>"
"documentation":"<p>The options that are available for a particular orderable instance.</p>"
},
"Marker":{
"shape":"String",
@ -3407,19 +3407,19 @@
"members":{
"DBInstanceClass":{
"shape":"String",
"documentation":"<p> Contains the new <code>DBInstanceClass</code> for the DB instance that will be applied or is currently being applied. </p>"
"documentation":"<p> Contains the new <code>DBInstanceClass</code> for the instance that will be applied or is currently being applied. </p>"
},
"AllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p> Contains the new <code>AllocatedStorage</code> size for the DB instance that will be applied or is currently being applied. </p>"
"documentation":"<p> Contains the new <code>AllocatedStorage</code> size for then instance that will be applied or is currently being applied. </p>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>Contains the pending or currently in-progress change of the master credentials for the DB instance.</p>"
"documentation":"<p>Contains the pending or currently in-progress change of the master credentials for the instance.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the pending port for the DB instance.</p>"
"documentation":"<p>Specifies the pending port for the instance.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@ -3427,7 +3427,7 @@
},
"MultiAZ":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.</p>"
"documentation":"<p>Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.</p>"
},
"EngineVersion":{
"shape":"String",
@ -3435,19 +3435,19 @@
},
"LicenseModel":{
"shape":"String",
"documentation":"<p>The license model for the DB instance.</p> <p>Valid values: <code>license-included</code>, <code>bring-your-own-license</code>, <code>general-public-license</code> </p>"
"documentation":"<p>The license model for the instance.</p> <p>Valid values: <code>license-included</code>, <code>bring-your-own-license</code>, <code>general-public-license</code> </p>"
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.</p>"
"documentation":"<p>Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.</p>"
},
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p> Contains the new <code>DBInstanceIdentifier</code> for the DB instance that will be applied or is currently being applied. </p>"
"documentation":"<p> Contains the new <code>DBInstanceIdentifier</code> for the instance that will be applied or is currently being applied. </p>"
},
"StorageType":{
"shape":"String",
"documentation":"<p>Specifies the storage type to be associated with the DB instance.</p>"
"documentation":"<p>Specifies the storage type to be associated with the instance.</p>"
},
"CACertificateIdentifier":{
"shape":"String",
@ -3455,14 +3455,14 @@
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The new DB subnet group for the DB instance. </p>"
"documentation":"<p>The new subnet group for the instance. </p>"
},
"PendingCloudwatchLogsExports":{
"shape":"PendingCloudwatchLogsExports",
"documentation":"<p>A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.</p>"
}
},
"documentation":"<p> One or more modified settings for a DB instance. These modified settings have been requested, but haven't been applied yet.</p>"
"documentation":"<p> One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.</p>"
},
"RebootDBInstanceMessage":{
"type":"structure",
@ -3470,7 +3470,7 @@
"members":{
"DBInstanceIdentifier":{
"shape":"String",
"documentation":"<p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
"documentation":"<p>The instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>"
},
"ForceFailover":{
"shape":"BooleanOptional",
@ -3509,15 +3509,15 @@
"members":{
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to reset.</p>"
"documentation":"<p>The name of the cluster parameter group to reset.</p>"
},
"ResetAllParameters":{
"shape":"Boolean",
"documentation":"<p>A value that is set to <code>true</code> to reset all parameters in the DB cluster parameter group to their default values, and <code>false</code> otherwise. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p>"
"documentation":"<p>A value that is set to <code>true</code> to reset all parameters in the cluster parameter group to their default values, and <code>false</code> otherwise. You can't use this parameter if there is a list of parameter names specified for the <code>Parameters</code> parameter.</p>"
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</p>"
"documentation":"<p>A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the <code>ResetAllParameters</code> parameter is set to <code>true</code>.</p>"
}
},
"documentation":"<p>Represents the input to <a>ResetDBClusterParameterGroup</a>.</p>"
@ -3563,39 +3563,39 @@
},
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-snapshot-id</code> </p>"
"documentation":"<p>The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>my-snapshot-id</code> </p>"
},
"SnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier for the DB snapshot or DB cluster snapshot to restore from.</p> <p>You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing snapshot.</p> </li> </ul>"
"documentation":"<p>The identifier for the snapshot or cluster snapshot to restore from.</p> <p>You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing snapshot.</p> </li> </ul>"
},
"Engine":{
"shape":"String",
"documentation":"<p>The database engine to use for the new DB cluster.</p> <p>Default: The same as source.</p> <p>Constraint: Must be compatible with the engine of the source.</p>"
"documentation":"<p>The database engine to use for the new cluster.</p> <p>Default: The same as source.</p> <p>Constraint: Must be compatible with the engine of the source.</p>"
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version of the database engine to use for the new DB cluster.</p>"
"documentation":"<p>The version of the database engine to use for the new cluster.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p> <p>Default: The same port as the original DB cluster.</p>"
"documentation":"<p>The port number on which the new cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p> <p>Default: The same port as the original cluster.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB subnet group to use for the new DB cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
"documentation":"<p>The name of the subnet group to use for the new cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to.</p>"
"documentation":"<p>A list of virtual private cloud (VPC) security groups that the new cluster will belong to.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the restored DB cluster.</p>"
"documentation":"<p>The tags to be assigned to the restored cluster.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the DB snapshot or DB cluster snapshot in <code>SnapshotIdentifier</code> is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot.</p> </li> <li> <p>If the DB snapshot or the DB cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul>"
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the snapshot or cluster snapshot in <code>SnapshotIdentifier</code> is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the snapshot or the cluster snapshot.</p> </li> <li> <p>If the snapshot or the cluster snapshot in <code>SnapshotIdentifier</code> is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@ -3623,39 +3623,39 @@
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The name of the new DB cluster to be created.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The name of the new cluster to be created.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"SourceDBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the source DB cluster from which to restore.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
"documentation":"<p>The identifier of the source cluster from which to restore.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"
},
"RestoreToTime":{
"shape":"TStamp",
"documentation":"<p>The date and time to restore the DB cluster to.</p> <p>Valid values: A time in Universal Coordinated Time (UTC) format.</p> <p>Constraints:</p> <ul> <li> <p>Must be before the latest restorable time for the DB instance.</p> </li> <li> <p>Must be specified if the <code>UseLatestRestorableTime</code> parameter is not provided.</p> </li> <li> <p>Cannot be specified if the <code>UseLatestRestorableTime</code> parameter is <code>true</code>.</p> </li> <li> <p>Cannot be specified if the <code>RestoreType</code> parameter is <code>copy-on-write</code>.</p> </li> </ul> <p>Example: <code>2015-03-07T23:45:00Z</code> </p>"
"documentation":"<p>The date and time to restore the cluster to.</p> <p>Valid values: A time in Universal Coordinated Time (UTC) format.</p> <p>Constraints:</p> <ul> <li> <p>Must be before the latest restorable time for the instance.</p> </li> <li> <p>Must be specified if the <code>UseLatestRestorableTime</code> parameter is not provided.</p> </li> <li> <p>Cannot be specified if the <code>UseLatestRestorableTime</code> parameter is <code>true</code>.</p> </li> <li> <p>Cannot be specified if the <code>RestoreType</code> parameter is <code>copy-on-write</code>.</p> </li> </ul> <p>Example: <code>2015-03-07T23:45:00Z</code> </p>"
},
"UseLatestRestorableTime":{
"shape":"Boolean",
"documentation":"<p>A value that is set to <code>true</code> to restore the DB cluster to the latest restorable backup time, and <code>false</code> otherwise. </p> <p>Default: <code>false</code> </p> <p>Constraints: Cannot be specified if the <code>RestoreToTime</code> parameter is provided.</p>"
"documentation":"<p>A value that is set to <code>true</code> to restore the cluster to the latest restorable backup time, and <code>false</code> otherwise. </p> <p>Default: <code>false</code> </p> <p>Constraints: Cannot be specified if the <code>RestoreToTime</code> parameter is provided.</p>"
},
"Port":{
"shape":"IntegerOptional",
"documentation":"<p>The port number on which the new DB cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The default port for the engine.</p>"
"documentation":"<p>The port number on which the new cluster accepts connections.</p> <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>. </p> <p>Default: The default port for the engine.</p>"
},
"DBSubnetGroupName":{
"shape":"String",
"documentation":"<p>The DB subnet group name to use for the new DB cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
"documentation":"<p>The subnet group name to use for the new cluster.</p> <p>Constraints: If provided, must match the name of an existing <code>DBSubnetGroup</code>.</p> <p>Example: <code>mySubnetgroup</code> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
"documentation":"<p>A list of VPC security groups that the new DB cluster belongs to.</p>"
"documentation":"<p>A list of VPC security groups that the new cluster belongs to.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the restored DB cluster.</p>"
"documentation":"<p>The tags to be assigned to the restored cluster.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>You can restore to a new DB cluster and encrypt the new DB cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS key identified by the <code>KmsKeyId</code> parameter.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the source DB cluster.</p> </li> <li> <p>If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.</p> </li> </ul> <p>If <code>DBClusterIdentifier</code> refers to a DB cluster that is not encrypted, then the restore request is rejected.</p>"
"documentation":"<p>The AWS KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>You can restore to a new cluster and encrypt the new cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the AWS KMS key identified by the <code>KmsKeyId</code> parameter.</p> <p>If you do not specify a value for the <code>KmsKeyId</code> parameter, then the following occurs:</p> <ul> <li> <p>If the cluster is encrypted, then the restored cluster is encrypted using the AWS KMS key that was used to encrypt the source cluster.</p> </li> <li> <p>If the cluster is not encrypted, then the restored cluster is not encrypted.</p> </li> </ul> <p>If <code>DBClusterIdentifier</code> refers to a cluster that is not encrypted, then the restore request is rejected.</p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@ -3690,7 +3690,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed number of DB snapshots.</p>",
"documentation":"<p>The request would cause you to exceed the allowed number of snapshots.</p>",
"error":{
"code":"SnapshotQuotaExceeded",
"httpStatusCode":400,
@ -3745,7 +3745,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The request would cause you to exceed the allowed amount of storage available across all DB instances.</p>",
"documentation":"<p>The request would cause you to exceed the allowed amount of storage available across all instances.</p>",
"error":{
"code":"StorageQuotaExceeded",
"httpStatusCode":400,
@ -3788,7 +3788,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The DB subnet is already in use in the Availability Zone.</p>",
"documentation":"<p>The subnet is already in use in the Availability Zone.</p>",
"error":{
"code":"SubnetAlreadyInUse",
"httpStatusCode":400,
@ -3855,7 +3855,7 @@
},
"Description":{
"shape":"String",
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"
"documentation":"<p>The version of the database engine that an instance can be upgraded to.</p>"
},
"AutoUpgrade":{
"shape":"Boolean",
@ -3866,7 +3866,7 @@
"documentation":"<p>A value that indicates whether a database engine is upgraded to a major version.</p>"
}
},
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"
"documentation":"<p>The version of the database engine that an instance can be upgraded to.</p>"
},
"ValidUpgradeTargetList":{
"type":"list",

View file

@ -2499,7 +2499,10 @@
},
"DisableLDAPSRequest":{
"type":"structure",
"required":["DirectoryId"],
"required":[
"DirectoryId",
"Type"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
@ -2644,7 +2647,10 @@
},
"EnableLDAPSRequest":{
"type":"structure",
"required":["DirectoryId"],
"required":[
"DirectoryId",
"Type"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",

View file

@ -96,11 +96,11 @@
},
"FirstBlockToken":{
"shape":"BlockToken",
"documentation":"<p>The block token for the block index of the <code>first snapshot ID</code> specified in the <code>list changed blocks</code> operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.</p>"
"documentation":"<p>The block token for the block index of the <code>FirstSnapshotId</code> specified in the <code>ListChangedBlocks</code> operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.</p>"
},
"SecondBlockToken":{
"shape":"BlockToken",
"documentation":"<p>The block token for the block index of the <code>second snapshot ID</code> specified in the <code>list changed blocks</code> operation.</p>"
"documentation":"<p>The block token for the block index of the <code>SecondSnapshotId</code> specified in the <code>ListChangedBlocks</code> operation.</p>"
}
},
"documentation":"<p>A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.</p>",
@ -140,13 +140,13 @@
},
"BlockIndex":{
"shape":"BlockIndex",
"documentation":"<p>The block index of the block from which to get data.</p> <p>Obtain the <code>block index</code> by running the <code>list changed blocks</code> or <code>list snapshot blocks</code> operations.</p>",
"documentation":"<p>The block index of the block from which to get data.</p> <p>Obtain the <code>BlockIndex</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
"location":"uri",
"locationName":"blockIndex"
},
"BlockToken":{
"shape":"BlockToken",
"documentation":"<p>The block token of the block from which to get data.</p> <p>Obtain the <code>block token</code> by running the <code>list changed blocks</code> or <code>list snapshot blocks</code> operations.</p>",
"documentation":"<p>The block token of the block from which to get data.</p> <p>Obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
"location":"querystring",
"locationName":"blockToken"
}
@ -167,7 +167,7 @@
},
"Checksum":{
"shape":"Checksum",
"documentation":"<p>The checksum generated for the block.</p>",
"documentation":"<p>The checksum generated for the block, which is Base64 encoded.</p>",
"location":"header",
"locationName":"x-amz-Checksum"
},
@ -186,13 +186,13 @@
"members":{
"FirstSnapshotId":{
"shape":"SnapshotId",
"documentation":"<p>The ID of the first snapshot to use for the comparison.</p>",
"documentation":"<p>The ID of the first snapshot to use for the comparison.</p> <important> <p>The <code>FirstSnapshotID</code> parameter must be specified with a <code>SecondSnapshotId</code> parameter; otherwise, an error occurs.</p> </important>",
"location":"querystring",
"locationName":"firstSnapshotId"
},
"SecondSnapshotId":{
"shape":"SnapshotId",
"documentation":"<p>The ID of the second snapshot to use for the comparison.</p>",
"documentation":"<p>The ID of the second snapshot to use for the comparison.</p> <important> <p>The <code>SecondSnapshotId</code> parameter must be specified with a <code>FirstSnapshotID</code> parameter; otherwise, an error occurs.</p> </important>",
"location":"uri",
"locationName":"secondSnapshotId"
},
@ -225,7 +225,7 @@
},
"ExpiryTime":{
"shape":"TimeStamp",
"documentation":"<p>The time when the <code>block token</code> expires.</p>"
"documentation":"<p>The time when the <code>BlockToken</code> expires.</p>"
},
"VolumeSize":{
"shape":"VolumeSize",
@ -280,7 +280,7 @@
},
"ExpiryTime":{
"shape":"TimeStamp",
"documentation":"<p>The time when the <code>block token</code> expires.</p>"
"documentation":"<p>The time when the <code>BlockToken</code> expires.</p>"
},
"VolumeSize":{
"shape":"VolumeSize",
@ -347,5 +347,5 @@
},
"VolumeSize":{"type":"long"}
},
"documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If youre an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs makes it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots, and then use EC2 instances to compare the differences.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a>. For more information about how to use the EBS direct APIs, see the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshots.html\">EBS direct APIs User Guide</a>. To view the currently supported AWS Regions and endpoints for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#ebs_region\">AWS Service Endpoints</a> in the <i>AWS General Reference</i>.</p>"
"documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If youre an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in the <i>AWS General Reference</i>.</p>"
}

View file

@ -427,6 +427,18 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FastSnapshotRestores"
},
"DescribeIpv6Pools": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Ipv6Pools"
},
"GetAssociatedIpv6PoolCidrs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Ipv6CidrAssociations"
}
}
}

File diff suppressed because one or more lines are too long

View file

@ -27,7 +27,7 @@
{"shape":"InvalidParameterException"},
{"shape":"ServerException"}
],
"documentation":"<p>Check the availability of multiple image layers in a specified registry and repository.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Checks the availability of one or more image layers in a repository.</p> <p>When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it is, then the image layer is skipped.</p> <p>When an image is pulled from a repository, each image layer is checked once to verify it is available to be pulled.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"BatchDeleteImage":{
"name":"BatchDeleteImage",
@ -42,7 +42,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Deletes a list of specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>.</p> <p>You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.</p> <p>You can completely delete an image (and all of its tags) by specifying the image's digest in your request.</p>"
"documentation":"<p>Deletes a list of specified images within a repository. Images are specified with either an <code>imageTag</code> or <code>imageDigest</code>.</p> <p>You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.</p> <p>You can completely delete an image (and all of its tags) by specifying the image's digest in your request.</p>"
},
"BatchGetImage":{
"name":"BatchGetImage",
@ -57,7 +57,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Gets detailed information for specified images within a specified repository. Images are specified with either <code>imageTag</code> or <code>imageDigest</code>.</p>"
"documentation":"<p>Gets detailed information for an image. Images are specified with either an <code>imageTag</code> or <code>imageDigest</code>.</p> <p>When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.</p>"
},
"CompleteLayerUpload":{
"name":"CompleteLayerUpload",
@ -77,7 +77,7 @@
{"shape":"LayerAlreadyExistsException"},
{"shape":"EmptyUploadException"}
],
"documentation":"<p>Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of the image layer for data validation purposes.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of the image layer for data validation purposes.</p> <p>When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"CreateRepository":{
"name":"CreateRepository",
@ -95,7 +95,7 @@
{"shape":"RepositoryAlreadyExistsException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html\">Amazon ECR Repositories</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
"documentation":"<p>Creates a repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html\">Amazon ECR Repositories</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"DeleteLifecyclePolicy":{
"name":"DeleteLifecyclePolicy",
@ -111,7 +111,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"LifecyclePolicyNotFoundException"}
],
"documentation":"<p>Deletes the specified lifecycle policy.</p>"
"documentation":"<p>Deletes the lifecycle policy associated with the specified repository.</p>"
},
"DeleteRepository":{
"name":"DeleteRepository",
@ -127,7 +127,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"RepositoryNotEmptyException"}
],
"documentation":"<p>Deletes an existing image repository. If a repository contains images, you must use the <code>force</code> option to delete it.</p>"
"documentation":"<p>Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the <code>force</code> option to delete the repository.</p>"
},
"DeleteRepositoryPolicy":{
"name":"DeleteRepositoryPolicy",
@ -143,7 +143,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"RepositoryPolicyNotFoundException"}
],
"documentation":"<p>Deletes the repository policy from a specified repository.</p>"
"documentation":"<p>Deletes the repository policy associated with the specified repository.</p>"
},
"DescribeImageScanFindings":{
"name":"DescribeImageScanFindings",
@ -160,7 +160,7 @@
{"shape":"ImageNotFoundException"},
{"shape":"ScanNotFoundException"}
],
"documentation":"<p>Describes the image scan findings for the specified image.</p>"
"documentation":"<p>Returns the scan findings for the specified image.</p>"
},
"DescribeImages":{
"name":"DescribeImages",
@ -176,7 +176,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"ImageNotFoundException"}
],
"documentation":"<p>Returns metadata about the images in a repository, including image size, image tags, and creation date.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
"documentation":"<p>Returns metadata about the images in a repository.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
},
"DescribeRepositories":{
"name":"DescribeRepositories",
@ -205,7 +205,7 @@
{"shape":"ServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the <code>docker</code> CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.</p> <p>The <code>authorizationToken</code> returned for each registry specified is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The AWS CLI offers an <code>aws ecr get-login</code> command that simplifies the login process.</p>"
"documentation":"<p>Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.</p> <p>The <code>authorizationToken</code> returned is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The AWS CLI offers an <code>get-login-password</code> command that simplifies the login process. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth\">Registry Authentication</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"GetDownloadUrlForLayer":{
"name":"GetDownloadUrlForLayer",
@ -222,7 +222,7 @@
{"shape":"LayerInaccessibleException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.</p> <p>When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"GetLifecyclePolicy":{
"name":"GetLifecyclePolicy",
@ -238,7 +238,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"LifecyclePolicyNotFoundException"}
],
"documentation":"<p>Retrieves the specified lifecycle policy.</p>"
"documentation":"<p>Retrieves the lifecycle policy for the specified repository.</p>"
},
"GetLifecyclePolicyPreview":{
"name":"GetLifecyclePolicyPreview",
@ -254,7 +254,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"LifecyclePolicyPreviewNotFoundException"}
],
"documentation":"<p>Retrieves the results of the specified lifecycle policy preview request.</p>"
"documentation":"<p>Retrieves the results of the lifecycle policy preview request for the specified repository.</p>"
},
"GetRepositoryPolicy":{
"name":"GetRepositoryPolicy",
@ -270,7 +270,7 @@
{"shape":"RepositoryNotFoundException"},
{"shape":"RepositoryPolicyNotFoundException"}
],
"documentation":"<p>Retrieves the repository policy for a specified repository.</p>"
"documentation":"<p>Retrieves the repository policy for the specified repository.</p>"
},
"InitiateLayerUpload":{
"name":"InitiateLayerUpload",
@ -285,7 +285,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Notify Amazon ECR that you intend to upload an image layer.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Notifies Amazon ECR that you intend to upload an image layer.</p> <p>When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether an image layer has been uploaded before is determined by the <a>BatchCheckLayerAvailability</a> API action.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"ListImages":{
"name":"ListImages",
@ -300,7 +300,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Lists all the image IDs for a given repository.</p> <p>You can filter images based on whether or not they are tagged by setting the <code>tagStatus</code> parameter to <code>TAGGED</code> or <code>UNTAGGED</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository.</p>"
"documentation":"<p>Lists all the image IDs for the specified repository.</p> <p>You can filter images based on whether or not they are tagged by using the <code>tagStatus</code> filter and specifying either <code>TAGGED</code>, <code>UNTAGGED</code> or <code>ANY</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -334,7 +334,7 @@
{"shape":"LimitExceededException"},
{"shape":"ImageTagAlreadyExistsException"}
],
"documentation":"<p>Creates or updates the image manifest and tags associated with an image.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Creates or updates the image manifest and tags associated with an image.</p> <p>When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and tags associated with the image.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"PutImageScanningConfiguration":{
"name":"PutImageScanningConfiguration",
@ -349,7 +349,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Updates the image scanning configuration for a repository.</p>"
"documentation":"<p>Updates the image scanning configuration for the specified repository.</p>"
},
"PutImageTagMutability":{
"name":"PutImageTagMutability",
@ -364,7 +364,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Updates the image tag mutability settings for a repository. When a repository is configured with tag immutability, all image tags within the repository will be prevented them from being overwritten. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html\">Image Tag Mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
"documentation":"<p>Updates the image tag mutability settings for the specified repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html\">Image Tag Mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"PutLifecyclePolicy":{
"name":"PutLifecyclePolicy",
@ -379,7 +379,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html\">Lifecycle Policy Template</a>.</p>"
"documentation":"<p>Creates or updates the lifecycle policy for the specified repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html\">Lifecycle Policy Template</a>.</p>"
},
"SetRepositoryPolicy":{
"name":"SetRepositoryPolicy",
@ -394,7 +394,7 @@
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"}
],
"documentation":"<p>Applies a repository policy on a specified repository to control access permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html\">Amazon ECR Repository Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
"documentation":"<p>Applies a repository policy to the specified repository to control access permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html\">Amazon ECR Repository Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"StartImageScan":{
"name":"StartImageScan",
@ -427,7 +427,7 @@
{"shape":"LifecyclePolicyNotFoundException"},
{"shape":"LifecyclePolicyPreviewInProgressException"}
],
"documentation":"<p>Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.</p>"
"documentation":"<p>Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.</p>"
},
"TagResource":{
"name":"TagResource",
@ -479,7 +479,7 @@
{"shape":"UploadNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Uploads an image layer part to Amazon ECR.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
"documentation":"<p>Uploads an image layer part to Amazon ECR.</p> <p>When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.</p> <note> <p>This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
}
},
"shapes":{
@ -1014,7 +1014,7 @@
"members":{
"registryIds":{
"shape":"GetAuthorizationTokenRegistryIdList",
"documentation":"<p>A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.</p>"
"documentation":"<p>A list of AWS account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.</p>"
}
}
},

View file

@ -0,0 +1,45 @@
{
"version": 2,
"waiters": {
"ImageScanComplete": {
"description": "Wait until an image scan is complete and findings can be accessed",
"operation": "DescribeImageScanFindings",
"delay": 5,
"maxAttempts": 60,
"acceptors": [
{
"state": "success",
"matcher": "path",
"argument": "imageScanStatus.status",
"expected": "COMPLETE"
},
{
"state": "failure",
"matcher": "path",
"argument": "imageScanStatus.status",
"expected": "FAILED"
}
]
},
"LifecyclePolicyPreviewComplete": {
"description": "Wait until a lifecycle policy preview request is complete and results can be accessed",
"operation": "GetLifecyclePolicyPreview",
"delay": 5,
"maxAttempts": 20,
"acceptors": [
{
"state": "success",
"matcher": "path",
"argument": "status",
"expected": "COMPLETE"
},
{
"state": "failure",
"matcher": "path",
"argument": "status",
"expected": "FAILED"
}
]
}
}
}

View file

@ -134,7 +134,7 @@
{"shape":"ClusterContainsTasksException"},
{"shape":"UpdateInProgressException"}
],
"documentation":"<p>Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>"
"documentation":"<p>Deletes the specified cluster. The cluster will transition to the <code>INACTIVE</code> state. Clusters with an <code>INACTIVE</code> status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> clusters persisting.</p> <p>You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>"
},
"DeleteService":{
"name":"DeleteService",
@ -940,7 +940,7 @@
},
"managedTerminationProtection":{
"shape":"ManagedTerminationProtection",
"documentation":"<p>The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.</p> <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>AWS Auto Scaling User Guide</i>.</p> <p>When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.</p>"
"documentation":"<p>The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.</p> <important> <p>When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.</p> </important> <p>When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>AWS Auto Scaling User Guide</i>.</p> <p>When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.</p>"
}
},
"documentation":"<p>The details of the Auto Scaling group for the capacity provider.</p>"
@ -1076,7 +1076,7 @@
},
"status":{
"shape":"String",
"documentation":"<p>The status of the cluster. The valid values are <code>ACTIVE</code> or <code>INACTIVE</code>. <code>ACTIVE</code> indicates that you can register container instances with the cluster and the associated instances can accept tasks.</p>"
"documentation":"<p>The status of the cluster. The following are the possible states that will be returned.</p> <dl> <dt>ACTIVE</dt> <dd> <p>The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.</p> </dd> <dt>PROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.</p> </dd> <dt>DEPROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.</p> </dd> <dt>FAILED</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.</p> </dd> <dt>INACTIVE</dt> <dd> <p>The cluster has been deleted. Clusters with an <code>INACTIVE</code> status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> clusters persisting.</p> </dd> </dl>"
},
"registeredContainerInstancesCount":{
"shape":"Integer",
@ -1306,7 +1306,7 @@
},
"cpu":{
"shape":"Integer",
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>"
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>"
},
"memory":{
"shape":"BoxedInteger",
@ -1406,7 +1406,7 @@
},
"dockerSecurityOptions":{
"shape":"StringList",
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html\">Using gMSAs for Windows Containers</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
},
"interactive":{
"shape":"BoxedBoolean",
@ -1471,7 +1471,7 @@
"documentation":"<p>The dependency condition of the container. The following are the available conditions and their behavior:</p> <ul> <li> <p> <code>START</code> - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.</p> </li> <li> <p> <code>COMPLETE</code> - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit.</p> </li> <li> <p> <code>SUCCESS</code> - This condition is the same as <code>COMPLETE</code>, but it also requires that the container exits with a <code>zero</code> status.</p> </li> <li> <p> <code>HEALTHY</code> - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.</p> </li> </ul>"
}
},
"documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If you are using tasks that use the Fargate launch type, container dependency parameters are not supported.</p> </note>"
"documentation":"<p>The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.</p> <p>Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the <code>ecs-init</code> package. If your container instances are launched from version <code>20190301</code> or later, then they contain the required versions of the container agent and <code>ecs-init</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.</p> </note>"
},
"ContainerInstance":{
"type":"structure",
@ -1861,6 +1861,10 @@
"clientToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
}
}
},
@ -2302,6 +2306,10 @@
"taskSets":{
"shape":"StringList",
"documentation":"<p>The ID or full Amazon Resource Name (ARN) of task sets to describe.</p>"
},
"include":{
"shape":"TaskSetFieldList",
"documentation":"<p>Specifies whether to see the resource tags for the task set. If <code>TAGS</code> is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.</p>"
}
}
},
@ -2450,6 +2458,21 @@
"documentation":"<p>This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify a <code>host</code> instead.</p>"
},
"Double":{"type":"double"},
"EFSVolumeConfiguration":{
"type":"structure",
"required":["fileSystemId"],
"members":{
"fileSystemId":{
"shape":"String",
"documentation":"<p>The Amazon EFS file system ID to use.</p>"
},
"rootDirectory":{
"shape":"String",
"documentation":"<p>The directory within the Amazon EFS file system to mount as the root directory inside the host.</p>"
}
},
"documentation":"<p>This parameter is specified when you are using an Amazon Elastic File System (Amazon EFS) file storage. Amazon EFS file systems are only supported when you are using the EC2 launch type.</p> <important> <p> <code>EFSVolumeConfiguration</code> remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms apply to your participation in this preview of <code>EFSVolumeConfiguration</code>.</p> </important>"
},
"EnvironmentVariables":{
"type":"list",
"member":{"shape":"KeyValuePair"}
@ -3070,7 +3093,7 @@
"members":{
"logDriver":{
"shape":"LogDriver",
"documentation":"<p>The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.</p> <p>For tasks using the Fargate launch type, the supported log drivers are <code>awslogs</code> and <code>splunk</code>.</p> <p>For tasks using the EC2 launch type, the supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>, <code>json-file</code>, <code>journald</code>, <code>logentries</code>, <code>syslog</code>, and <code>splunk</code>.</p> <p>For more information about using the <code>awslogs</code> log driver, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html\">Using the awslogs Log Driver</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is <a href=\"https://github.com/aws/amazon-ecs-agent\">available on GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '{{.Server.APIVersion}}'</code> </p>"
"documentation":"<p>The log driver to use for the container. The valid values listed earlier are log drivers that the Amazon ECS container agent can communicate with by default.</p> <p>For tasks using the Fargate launch type, the supported log drivers are <code>awslogs</code>, <code>splunk</code>, and <code>awsfirelens</code>.</p> <p>For tasks using the EC2 launch type, the supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>, <code>json-file</code>, <code>journald</code>, <code>logentries</code>,<code>syslog</code>, <code>splunk</code>, and <code>awsfirelens</code>.</p> <p>For more information about using the <code>awslogs</code> log driver, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html\">Using the awslogs Log Driver</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>For more information about using the <code>awsfirelens</code> log driver, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is <a href=\"https://github.com/aws/amazon-ecs-agent\">available on GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.</p> </note>"
},
"options":{
"shape":"LogConfigurationOptionsMap",
@ -3081,7 +3104,7 @@
"documentation":"<p>The secrets to pass to the log configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html\">Specifying Sensitive Data</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>Log configuration options to send to a custom log driver for the container.</p>"
"documentation":"<p>The log configuration specification for the container.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\"> <code>docker run</code> </a>. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <p>The following should be noted when specifying a log configuration for your containers:</p> <ul> <li> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.</p> </li> <li> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.</p> </li> <li> <p>For tasks using the EC2 launch type, the Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>For tasks using the Fargate launch type, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.</p> </li> </ul>"
},
"LogConfigurationOptionsMap":{
"type":"map",
@ -3495,7 +3518,7 @@
},
"capacityProviders":{
"shape":"StringList",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p>"
"documentation":"<p>The name of one or more capacity providers to associate with the cluster.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p>"
},
"defaultCapacityProviderStrategy":{
"shape":"CapacityProviderStrategy",
@ -4582,7 +4605,7 @@
},
"family":{
"shape":"String",
"documentation":"<p>The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.</p>"
"documentation":"<p>The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p> <p>A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.</p>"
},
"taskRoleArn":{
"shape":"String",
@ -4824,10 +4847,22 @@
"stabilityStatusAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the task set stability status was retrieved.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.</p> </li> </ul>"
}
},
"documentation":"<p>Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an <code>EXTERNAL</code> deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.</p>"
},
"TaskSetField":{
"type":"string",
"enum":["TAGS"]
},
"TaskSetFieldList":{
"type":"list",
"member":{"shape":"TaskSetField"}
},
"TaskSetNotFoundException":{
"type":"structure",
"members":{
@ -5189,7 +5224,11 @@
},
"dockerVolumeConfiguration":{
"shape":"DockerVolumeConfiguration",
"documentation":"<p>This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify a <code>host</code> instead.</p>"
"documentation":"<p>This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify the <code>host</code> parameter instead.</p>"
},
"efsVolumeConfiguration":{
"shape":"EFSVolumeConfiguration",
"documentation":"<p>This parameter is specified when you are using an Amazon Elastic File System (Amazon EFS) file storage. Amazon EFS file systems are only supported when you are using the EC2 launch type.</p> <important> <p> <code>EFSVolumeConfiguration</code> remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at <a href=\"https://aws.amazon.com/service-terms\">https://aws.amazon.com/service-terms</a> (\"Beta Terms\"). These Beta Terms apply to your participation in this preview of <code>EFSVolumeConfiguration</code>.</p> </important>"
}
},
"documentation":"<p>A data volume used in a task definition. For tasks that use a Docker volume, specify a <code>DockerVolumeConfiguration</code>. For tasks that use a bind mount host volume, specify a <code>host</code> and optional <code>sourcePath</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html\">Using Data Volumes in Tasks</a>.</p>"

View file

@ -11,6 +11,24 @@
"uid":"elasticfilesystem-2015-02-01"
},
"operations":{
"CreateAccessPoint":{
"name":"CreateAccessPoint",
"http":{
"method":"POST",
"requestUri":"/2015-02-01/access-points",
"responseCode":200
},
"input":{"shape":"CreateAccessPointRequest"},
"output":{"shape":"AccessPointDescription"},
"errors":[
{"shape":"BadRequest"},
{"shape":"AccessPointAlreadyExists"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"AccessPointLimitExceeded"}
],
"documentation":"<p>Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html\">Mounting a File System Using EFS Access Points</a>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p>"
},
"CreateFileSystem":{
"name":"CreateFileSystem",
"http":{
@ -68,7 +86,24 @@
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"}
],
"documentation":"<p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the <code>Name</code> tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> operation. </p> <p>This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action.</p>"
"documentation":"<p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the <code>Name</code> tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> operation. </p> <p>This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action.</p>",
"deprecated":true,
"deprecatedMessage":"Use TagResource."
},
"DeleteAccessPoint":{
"name":"DeleteAccessPoint",
"http":{
"method":"DELETE",
"requestUri":"/2015-02-01/access-points/{AccessPointId}",
"responseCode":204
},
"input":{"shape":"DeleteAccessPointRequest"},
"errors":[
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteAccessPoint</code> action.</p>"
},
"DeleteFileSystem":{
"name":"DeleteFileSystem",
@ -86,6 +121,21 @@
],
"documentation":"<p>Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.</p> <p> You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> <note> <p>The <code>DeleteFileSystem</code> call returns while the file system state is still <code>deleting</code>. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> returns a <code>404 FileSystemNotFound</code> error.</p> </note> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteFileSystem</code> action.</p>"
},
"DeleteFileSystemPolicy":{
"name":"DeleteFileSystemPolicy",
"http":{
"method":"DELETE",
"requestUri":"/2015-02-01/file-systems/{FileSystemId}/policy",
"responseCode":200
},
"input":{"shape":"DeleteFileSystemPolicyRequest"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"IncorrectFileSystemLifeCycleState"}
],
"documentation":"<p>Deletes the <code>FileSystemPolicy</code> for the specified file system. The default <code>FileSystemPolicy</code> goes into effect once the existing policy is deleted. 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:DeleteFileSystemPolicy</code> action.</p>"
},
"DeleteMountTarget":{
"name":"DeleteMountTarget",
"http":{
@ -115,7 +165,42 @@
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"}
],
"documentation":"<p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteTags</code> action.</p>"
"documentation":"<p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DeleteTags</code> action.</p>",
"deprecated":true,
"deprecatedMessage":"Use UntagResource."
},
"DescribeAccessPoints":{
"name":"DescribeAccessPoints",
"http":{
"method":"GET",
"requestUri":"/2015-02-01/access-points",
"responseCode":200
},
"input":{"shape":"DescribeAccessPointsRequest"},
"output":{"shape":"DescribeAccessPointsResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided. If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>"
},
"DescribeFileSystemPolicy":{
"name":"DescribeFileSystemPolicy",
"http":{
"method":"GET",
"requestUri":"/2015-02-01/file-systems/{FileSystemId}/policy",
"responseCode":200
},
"input":{"shape":"DescribeFileSystemPolicyRequest"},
"output":{"shape":"FileSystemPolicyDescription"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"PolicyNotFound"}
],
"documentation":"<p>Returns the <code>FileSystemPolicy</code> for the specified EFS file system.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeFileSystemPolicy</code> action.</p>"
},
"DescribeFileSystems":{
"name":"DescribeFileSystems",
@ -179,7 +264,8 @@
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"MountTargetNotFound"}
{"shape":"MountTargetNotFound"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeMountTargets</code> action, on either the file system ID that you specify in <code>FileSystemId</code>, or on the file system of the mount target that you specify in <code>MountTargetId</code>.</p>"
},
@ -197,7 +283,26 @@
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"}
],
"documentation":"<p>Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. </p> <p> This operation requires permissions for the <code>elasticfilesystem:DescribeTags</code> action. </p>"
"documentation":"<p>Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. </p> <p> This operation requires permissions for the <code>elasticfilesystem:DescribeTags</code> action. </p>",
"deprecated":true,
"deprecatedMessage":"Use ListTagsForResource."
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/2015-02-01/resource-tags/{ResourceId}",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for.</p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>"
},
"ModifyMountTargetSecurityGroups":{
"name":"ModifyMountTargetSecurityGroups",
@ -217,6 +322,23 @@
],
"documentation":"<p>Modifies the set of security groups in effect for a mount target.</p> <p>When you create a mount target, Amazon EFS also creates a new network interface. For more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <code>deleted</code>. </p> <p>The operation requires permissions for the following actions:</p> <ul> <li> <p> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </p> </li> <li> <p> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </p> </li> </ul>"
},
"PutFileSystemPolicy":{
"name":"PutFileSystemPolicy",
"http":{
"method":"PUT",
"requestUri":"/2015-02-01/file-systems/{FileSystemId}/policy",
"responseCode":200
},
"input":{"shape":"PutFileSystemPolicyRequest"},
"output":{"shape":"FileSystemPolicyDescription"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"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>"
},
"PutLifecycleConfiguration":{
"name":"PutLifecycleConfiguration",
"http":{
@ -234,6 +356,38 @@
],
"documentation":"<p>Enables lifecycle management by creating a new <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A <code>LifecycleConfiguration</code> applies to all files in a file system.</p> <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a <code>LifecycleConfiguration</code> object already exists for the specified file system, a <code>PutLifecycleConfiguration</code> call modifies the existing configuration. A <code>PutLifecycleConfiguration</code> call with an empty <code>LifecyclePolicies</code> array in the request body deletes any existing <code>LifecycleConfiguration</code> and disables lifecycle management.</p> <p>In the request, specify the following: </p> <ul> <li> <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.</p> </li> <li> <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that define when files are moved to the IA storage class. The array can contain only one <code>LifecyclePolicy</code> item.</p> </li> </ul> <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system. </p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/2015-02-01/resource-tags/{ResourceId}",
"responseCode":200
},
"input":{"shape":"TagResourceRequest"},
"errors":[
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation.</p> <p>This operation requires permissions for the <code>elasticfilesystem:TagResource</code> action.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/2015-02-01/resource-tags/{ResourceId}",
"responseCode":200
},
"input":{"shape":"UntagResourceRequest"},
"errors":[
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemNotFound"},
{"shape":"AccessPointNotFound"}
],
"documentation":"<p>Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation.</p> <p>This operation requires permissions for the <code>elasticfilesystem:UntagResource</code> action.</p>"
},
"UpdateFileSystem":{
"name":"UpdateFileSystem",
"http":{
@ -256,6 +410,97 @@
}
},
"shapes":{
"AccessPointAlreadyExists":{
"type":"structure",
"required":[
"ErrorCode",
"AccessPointId"
],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"},
"AccessPointId":{"shape":"AccessPointId"}
},
"documentation":"<p>Returned if the access point you are trying to create already exists, with the creation token you provided in the request.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"AccessPointArn":{"type":"string"},
"AccessPointDescription":{
"type":"structure",
"members":{
"ClientToken":{
"shape":"ClientToken",
"documentation":"<p>The opaque string specified in the request to ensure idempotent creation.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the access point. This is the value of the <code>Name</code> tag.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags associated with the access point, presented as an array of Tag objects.</p>"
},
"AccessPointId":{
"shape":"AccessPointId",
"documentation":"<p>The ID of the access point, assigned by Amazon EFS.</p>"
},
"AccessPointArn":{
"shape":"AccessPointArn",
"documentation":"<p>The unique Amazon Resource Name (ARN) associated with the access point.</p>"
},
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>The ID of the EFS file system that the access point applies to.</p>"
},
"PosixUser":{
"shape":"PosixUser",
"documentation":"<p>The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.</p>"
},
"RootDirectory":{
"shape":"RootDirectory",
"documentation":"<p>The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.</p>"
},
"OwnerId":{
"shape":"AwsAccountId",
"documentation":"<p>Identified the AWS account that owns the access point resource.</p>"
},
"LifeCycleState":{
"shape":"LifeCycleState",
"documentation":"<p>Identifies the lifecycle phase of the access point.</p>"
}
},
"documentation":"<p>Provides a description of an EFS file system access point.</p>"
},
"AccessPointDescriptions":{
"type":"list",
"member":{"shape":"AccessPointDescription"}
},
"AccessPointId":{"type":"string"},
"AccessPointLimitExceeded":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the AWS account has already created the maximum number of access points allowed per file system.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AccessPointNotFound":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the specified <code>AccessPointId</code> value doesn't exist in the requester's AWS account.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"AvailabilityZoneId":{"type":"string"},
"AvailabilityZoneName":{"type":"string"},
"AwsAccountId":{"type":"string"},
"BadRequest":{
"type":"structure",
@ -268,13 +513,50 @@
"error":{"httpStatusCode":400},
"exception":true
},
"BypassPolicyLockoutSafetyCheck":{"type":"boolean"},
"ClientToken":{
"type":"string",
"max":64,
"min":1
},
"CreateAccessPointRequest":{
"type":"structure",
"required":[
"ClientToken",
"FileSystemId"
],
"members":{
"ClientToken":{
"shape":"ClientToken",
"documentation":"<p>A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Creates tags associated with the access point. Each tag is a key-value pair.</p>"
},
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>The ID of the EFS file system that the access point provides access to.</p>"
},
"PosixUser":{
"shape":"PosixUser",
"documentation":"<p>The operating system user and group applied to all file system requests made using the access point.</p>"
},
"RootDirectory":{
"shape":"RootDirectory",
"documentation":"<p>Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the <code>RootDirectory</code> &gt; <code>Path</code> specified does not exist, EFS creates it and applies the <code>CreationInfo</code> settings when a client connects to an access point. When specifying a <code>RootDirectory</code>, you need to provide the <code>Path</code>, and the <code>CreationInfo</code> is optional.</p>"
}
}
},
"CreateFileSystemRequest":{
"type":"structure",
"required":["CreationToken"],
"members":{
"CreationToken":{
"shape":"CreationToken",
"documentation":"<p>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</p>"
"documentation":"<p>A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.</p>",
"idempotencyToken":true
},
"PerformanceMode":{
"shape":"PerformanceMode",
@ -348,11 +630,58 @@
},
"documentation":"<p/>"
},
"CreationInfo":{
"type":"structure",
"required":[
"OwnerUid",
"OwnerGid",
"Permissions"
],
"members":{
"OwnerUid":{
"shape":"OwnerUid",
"documentation":"<p>Specifies the POSIX user ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>"
},
"OwnerGid":{
"shape":"OwnerGid",
"documentation":"<p>Specifies the POSIX group ID to apply to the <code>RootDirectory</code>. Accepts values from 0 to 2^32 (4294967295).</p>"
},
"Permissions":{
"shape":"Permissions",
"documentation":"<p>Specifies the POSIX permissions to apply to the <code>RootDirectory</code>, in the format of an octal number representing the file's mode bits.</p>"
}
},
"documentation":"<p>Required if the <code>RootDirectory</code> &gt; <code>Path</code> specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code> &gt; <code>Path</code>. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying <code>CreationInfo</code>, you must include values for all properties. </p> <important> <p>If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> does not exist, attempts to mount the file system using the access point will fail.</p> </important>"
},
"CreationToken":{
"type":"string",
"max":64,
"min":1
},
"DeleteAccessPointRequest":{
"type":"structure",
"required":["AccessPointId"],
"members":{
"AccessPointId":{
"shape":"AccessPointId",
"documentation":"<p>The ID of the access point that you want to delete.</p>",
"location":"uri",
"locationName":"AccessPointId"
}
}
},
"DeleteFileSystemPolicyRequest":{
"type":"structure",
"required":["FileSystemId"],
"members":{
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>Specifies the EFS file system for which to delete the <code>FileSystemPolicy</code>.</p>",
"location":"uri",
"locationName":"FileSystemId"
}
}
},
"DeleteFileSystemRequest":{
"type":"structure",
"required":["FileSystemId"],
@ -410,12 +739,66 @@
"error":{"httpStatusCode":504},
"exception":true
},
"DescribeAccessPointsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>(Optional) When retrieving all access points for a file system, you can optionally specify the <code>MaxItems</code> parameter to limit the number of objects returned in a response. The default value is 100. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"Token",
"documentation":"<p> <code>NextToken</code> is present if the response is paginated. You can use <code>NextMarker</code> in the subsequent request to fetch the next page of access point descriptions.</p>",
"location":"querystring",
"locationName":"NextToken"
},
"AccessPointId":{
"shape":"AccessPointId",
"documentation":"<p>(Optional) Specifies an EFS access point to describe in the response; mutually exclusive with <code>FileSystemId</code>.</p>",
"location":"querystring",
"locationName":"AccessPointId"
},
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access points for that file system; mutually exclusive with <code>AccessPointId</code>.</p>",
"location":"querystring",
"locationName":"FileSystemId"
}
}
},
"DescribeAccessPointsResponse":{
"type":"structure",
"members":{
"AccessPoints":{
"shape":"AccessPointDescriptions",
"documentation":"<p>An array of access point descriptions.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.</p>"
}
}
},
"DescribeFileSystemPolicyRequest":{
"type":"structure",
"required":["FileSystemId"],
"members":{
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code> for.</p>",
"location":"uri",
"locationName":"FileSystemId"
}
}
},
"DescribeFileSystemsRequest":{
"type":"structure",
"members":{
"MaxItems":{
"shape":"MaxItems",
"documentation":"<p>(Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 file systems. </p>",
"documentation":"<p>(Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems. </p>",
"location":"querystring",
"locationName":"MaxItems"
},
@ -497,7 +880,7 @@
"members":{
"MaxItems":{
"shape":"MaxItems",
"documentation":"<p>(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 mount targets.</p>",
"documentation":"<p>(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.</p>",
"location":"querystring",
"locationName":"MaxItems"
},
@ -509,15 +892,21 @@
},
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if <code>MountTargetId</code> is not included.</p>",
"documentation":"<p>(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an <code>AccessPointId</code> or <code>MountTargetId</code> is not included. Accepts either a file system ID or ARN as input.</p>",
"location":"querystring",
"locationName":"FileSystemId"
},
"MountTargetId":{
"shape":"MountTargetId",
"documentation":"<p>(Optional) ID of the mount target that you want to have described (String). It must be included in your request if <code>FileSystemId</code> is not included.</p>",
"documentation":"<p>(Optional) ID of the mount target that you want to have described (String). It must be included in your request if <code>FileSystemId</code> is not included. Accepts either a mount target ID or ARN as input.</p>",
"location":"querystring",
"locationName":"MountTargetId"
},
"AccessPointId":{
"shape":"AccessPointId",
"documentation":"<p>(Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a <code>FileSystemId</code> or <code>MountTargetId</code> is not included in your request. Accepts either an access point ID or ARN as input.</p>",
"location":"querystring",
"locationName":"AccessPointId"
}
},
"documentation":"<p/>"
@ -546,7 +935,7 @@
"members":{
"MaxItems":{
"shape":"MaxItems",
"documentation":"<p>(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 tags.</p>",
"documentation":"<p>(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.</p>",
"location":"querystring",
"locationName":"MaxItems"
},
@ -720,6 +1109,19 @@
"type":"long",
"min":0
},
"FileSystemPolicyDescription":{
"type":"structure",
"members":{
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>Specifies the EFS file system to which the <code>FileSystemPolicy</code> applies.</p>"
},
"Policy":{
"shape":"Policy",
"documentation":"<p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file system.</p>"
}
}
},
"FileSystemSize":{
"type":"structure",
"required":["Value"],
@ -747,6 +1149,11 @@
"type":"long",
"min":0
},
"Gid":{
"type":"long",
"max":4294967295,
"min":0
},
"IncorrectFileSystemLifeCycleState":{
"type":"structure",
"required":["ErrorCode"],
@ -791,6 +1198,16 @@
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidPolicyException":{
"type":"structure",
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the <code>FileSystemPolicy</code> is is malformed or contains an error such as an invalid parameter value or a missing required parameter. Returned in the case of a policy lockout safety check error.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"IpAddress":{"type":"string"},
"IpAddressInUse":{
"type":"structure",
@ -841,11 +1258,52 @@
},
"documentation":"<p>Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.</p>"
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.</p>",
"location":"uri",
"locationName":"ResourceId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>(Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.</p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.</p>",
"location":"querystring",
"locationName":"NextToken"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"Tags",
"documentation":"<p>An array of the tags for the specified EFS resource.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p> <code>NextToken</code> is present if the response payload is paginated. You can use <code>NextToken</code> in a subsequent request to fetch the next page of access point descriptions.</p>"
}
}
},
"Marker":{"type":"string"},
"MaxItems":{
"type":"integer",
"min":1
},
"MaxResults":{
"type":"integer",
"min":1
},
"ModifyMountTargetSecurityGroupsRequest":{
"type":"structure",
"required":["MountTargetId"],
@ -914,6 +1372,14 @@
"NetworkInterfaceId":{
"shape":"NetworkInterfaceId",
"documentation":"<p>The ID of the network interface that Amazon EFS created when it created the mount target.</p>"
},
"AvailabilityZoneId":{
"shape":"AvailabilityZoneId",
"documentation":"<p>The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. For example, <code>use1-az1</code> is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.</p>"
},
"AvailabilityZoneName":{
"shape":"AvailabilityZoneName",
"documentation":"<p>The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names for each AWS account. For example, the Availability Zone <code>us-east-1a</code> for your AWS account might not be the same location as <code>us-east-1a</code> for another AWS account.</p>"
}
},
"documentation":"<p>Provides a description of a mount target.</p>"
@ -934,6 +1400,7 @@
"error":{"httpStatusCode":404},
"exception":true
},
"Name":{"type":"string"},
"NetworkInterfaceId":{"type":"string"},
"NetworkInterfaceLimitExceeded":{
"type":"structure",
@ -957,6 +1424,21 @@
"error":{"httpStatusCode":409},
"exception":true
},
"OwnerGid":{
"type":"long",
"max":4294967295,
"min":0
},
"OwnerUid":{
"type":"long",
"max":4294967295,
"min":0
},
"Path":{
"type":"string",
"max":100,
"min":1
},
"PerformanceMode":{
"type":"string",
"enum":[
@ -964,10 +1446,70 @@
"maxIO"
]
},
"Permissions":{
"type":"string",
"pattern":"^[0-7]{3,4}$"
},
"Policy":{"type":"string"},
"PolicyNotFound":{
"type":"structure",
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the default file system policy is in effect for the EFS file system specified.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"PosixUser":{
"type":"structure",
"required":[
"Uid",
"Gid"
],
"members":{
"Uid":{
"shape":"Uid",
"documentation":"<p>The POSIX user ID used for all file system operations using this access point.</p>"
},
"Gid":{
"shape":"Gid",
"documentation":"<p>The POSIX group ID used for all file system operations using this access point.</p>"
},
"SecondaryGids":{
"shape":"SecondaryGids",
"documentation":"<p>Secondary POSIX group IDs used for all file system operations using this access point.</p>"
}
},
"documentation":"<p>The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.</p>"
},
"ProvisionedThroughputInMibps":{
"type":"double",
"min":1.0
},
"PutFileSystemPolicyRequest":{
"type":"structure",
"required":[
"FileSystemId",
"Policy"
],
"members":{
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>The ID of the EFS file system that you want to create or update the <code>FileSystemPolicy</code> for.</p>",
"location":"uri",
"locationName":"FileSystemId"
},
"Policy":{
"shape":"Policy",
"documentation":"<p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted policy definition. To find out more about the elements that make up a file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies\">EFS Resource-based Policies</a>. </p>"
},
"BypassPolicyLockoutSafetyCheck":{
"shape":"BypassPolicyLockoutSafetyCheck",
"documentation":"<p>(Optional) A flag to indicate whether to bypass the <code>FileSystemPolicy</code> lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future <code>PutFileSystemPolicy</code> requests on the file system. Set <code>BypassPolicyLockoutSafetyCheck</code> to <code>True</code> only when you intend to prevent the principal that is making the request from making a subsequent <code>PutFileSystemPolicy</code> request on the file system. The default value is False. </p>"
}
}
},
"PutLifecycleConfigurationRequest":{
"type":"structure",
"required":[
@ -987,6 +1529,27 @@
}
}
},
"ResourceId":{"type":"string"},
"RootDirectory":{
"type":"structure",
"members":{
"Path":{
"shape":"Path",
"documentation":"<p>Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the <code>CreationInfo</code>.</p>"
},
"CreationInfo":{
"shape":"CreationInfo",
"documentation":"<p>(Optional) Specifies the POSIX IDs and permissions to apply to the access point's <code>RootDirectory</code>. If the <code>RootDirectory</code> &gt; <code>Path</code> specified does not exist, EFS creates the root directory using the <code>CreationInfo</code> settings when a client connects to an access point. When specifying the <code>CreationInfo</code>, you must provide values for all properties. </p> <important> <p>If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> &gt; <code>Path</code> does not exist, attempts to mount the file system using the access point will fail.</p> </important>"
}
},
"documentation":"<p>Specifies the directory on the Amazon EFS file system that the access point provides access to. The access point exposes the specified file system path as the root directory of your file system to applications using the access point. NFS clients using the access point can only access data in the access point's <code>RootDirectory</code> and it's subdirectories.</p>"
},
"SecondaryGids":{
"type":"list",
"member":{"shape":"Gid"},
"max":16,
"min":0
},
"SecurityGroup":{"type":"string"},
"SecurityGroupLimitExceeded":{
"type":"structure",
@ -1052,7 +1615,28 @@
},
"TagKeys":{
"type":"list",
"member":{"shape":"TagKey"}
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceId",
"Tags"
],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID specifying the EFS resource that you want to create a tag for. </p>",
"location":"uri",
"locationName":"ResourceId"
},
"Tags":{
"shape":"Tags",
"documentation":"<p/>"
}
}
},
"TagValue":{
"type":"string",
@ -1081,6 +1665,7 @@
]
},
"Timestamp":{"type":"timestamp"},
"Token":{"type":"string"},
"TooManyRequests":{
"type":"structure",
"required":["ErrorCode"],
@ -1102,6 +1687,11 @@
"AFTER_90_DAYS"
]
},
"Uid":{
"type":"long",
"max":4294967295,
"min":0
},
"UnsupportedAvailabilityZone":{
"type":"structure",
"required":["ErrorCode"],
@ -1113,6 +1703,22 @@
"error":{"httpStatusCode":400},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>Specifies the EFS resource that you want to remove tags from.</p>",
"location":"uri",
"locationName":"ResourceId"
},
"TagKeys":{
"shape":"TagKeys",
"documentation":"<p>The keys of the key:value tag pairs that you want to remove from the specified EFS resource.</p>"
}
}
},
"UpdateFileSystemRequest":{
"type":"structure",
"required":["FileSystemId"],

View file

@ -48,7 +48,7 @@
{"shape":"ResourceLimitExceededException"},
{"shape":"UnsupportedAvailabilityZoneException"}
],
"documentation":"<p>Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to schedule pods on Fargate infrastructure.</p> <p>The Fargate profile allows an administrator to declare which pods run on Fargate infrastructure and specify which pods run on which Fargate profile. This declaration is done through the profiles selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate infrastructure. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate infrastructure.</p> <p>When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes <a href=\"https://kubernetes.io/docs/admin/authorization/rbac/\">Role Based Access Control</a> (RBAC) for authorization so that the <code>kubelet</code> that is running on the Fargate infrastructure can register with your Amazon EKS cluster. This role is what allows Fargate infrastructure to appear in your cluster as nodes. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p> <p>Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.</p> <p>If any Fargate profiles in a cluster are in the <code>DELETING</code> status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html\">AWS Fargate Profile</a> in the <i>Amazon EKS User Guide</i>.</p>"
"documentation":"<p>Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.</p> <p>The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profiles selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.</p> <p>When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes <a href=\"https://kubernetes.io/docs/admin/authorization/rbac/\">Role Based Access Control</a> (RBAC) for authorization so that the <code>kubelet</code> that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p> <p>Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.</p> <p>If any Fargate profiles in a cluster are in the <code>DELETING</code> status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html\">AWS Fargate Profile</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"CreateNodegroup":{
"name":"CreateNodegroup",
@ -100,7 +100,7 @@
{"shape":"ServerException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes an AWS Fargate profile.</p> <p>When you delete a Fargate profile, any pods that were scheduled onto Fargate infrastructure with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate infrastructure with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate infrastructure.</p> <p>Only one Fargate profile in a cluster can be in the <code>DELETING</code> status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.</p>"
"documentation":"<p>Deletes an AWS Fargate profile.</p> <p>When you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate and they may remain in a pending state.</p> <p>Only one Fargate profile in a cluster can be in the <code>DELETING</code> status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.</p>"
},
"DeleteNodegroup":{
"name":"DeleteNodegroup",
@ -587,7 +587,7 @@
},
"subnets":{
"shape":"StringList",
"documentation":"<p>The IDs of subnets to launch Fargate pods into. At this time, Fargate pods are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.</p>"
"documentation":"<p>The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.</p>"
},
"selectors":{
"shape":"FargateProfileSelectors",
@ -949,11 +949,11 @@
},
"podExecutionRoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see <a href=\"eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"subnets":{
"shape":"StringList",
"documentation":"<p>The IDs of subnets to launch Fargate pods into.</p>"
"documentation":"<p>The IDs of subnets to launch pods into.</p>"
},
"selectors":{
"shape":"FargateProfileSelectors",
@ -1403,10 +1403,12 @@
"type":"string",
"enum":[
"AutoScalingGroupNotFound",
"AutoScalingGroupInvalidConfiguration",
"Ec2SecurityGroupNotFound",
"Ec2SecurityGroupDeletionFailure",
"Ec2LaunchTemplateNotFound",
"Ec2LaunchTemplateVersionMismatch",
"Ec2SubnetNotFound",
"IamInstanceProfileNotFound",
"IamNodeRoleNotFound",
"AsgInstanceLaunchFailures",
@ -1891,7 +1893,8 @@
"LabelsToRemove",
"MaxSize",
"MinSize",
"ReleaseVersion"
"ReleaseVersion",
"PublicAccessCidrs"
]
},
"UpdateParams":{
@ -1929,11 +1932,15 @@
},
"endpointPublicAccess":{
"shape":"BoxedBoolean",
"documentation":"<p>Set this value to <code>false</code> to disable public access for your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can receive only requests from within the cluster VPC. The default value for this parameter is <code>true</code>, which enables public access for your Kubernetes API server. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>Set this value to <code>false</code> to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is <code>true</code>, which enables public access for your Kubernetes API server. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"endpointPrivateAccess":{
"shape":"BoxedBoolean",
"documentation":"<p>Set this value to <code>true</code> to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is <code>false</code>, which disables private access for your Kubernetes API server. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>Set this value to <code>true</code> to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is <code>false</code>, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"publicAccessCidrs":{
"shape":"StringList",
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
}
},
"documentation":"<p>An object representing the VPC configuration to use for an Amazon EKS cluster.</p>"
@ -1959,11 +1966,15 @@
},
"endpointPublicAccess":{
"shape":"Boolean",
"documentation":"<p>This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can receive only requests that originate from within the cluster VPC. </p>"
"documentation":"<p>This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.</p>"
},
"endpointPrivateAccess":{
"shape":"Boolean",
"documentation":"<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet.</p>"
"documentation":"<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"publicAccessCidrs":{
"shape":"StringList",
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster VPC configuration response.</p>"

View file

@ -71,7 +71,7 @@
"us-east-1" : { }
}
},
"acm" : {
"access-analyzer" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
@ -93,6 +93,58 @@
"us-west-2" : { }
}
},
"acm" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"ca-central-1-fips" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "acm-fips.ca-central-1.amazonaws.com"
},
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "acm-fips.us-east-1.amazonaws.com"
},
"us-east-2" : { },
"us-east-2-fips" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "acm-fips.us-east-2.amazonaws.com"
},
"us-west-1" : { },
"us-west-1-fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "acm-fips.us-west-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "acm-fips.us-west-2.amazonaws.com"
}
}
},
"acm-pca" : {
"defaults" : {
"protocols" : [ "https" ]
@ -384,9 +436,12 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -447,6 +502,7 @@
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -586,9 +642,15 @@
"cloud9" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -767,6 +829,7 @@
},
"codecommit" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -973,8 +1036,10 @@
"connect" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -1198,6 +1263,12 @@
},
"hostname" : "rds.ap-southeast-2.amazonaws.com"
},
"ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "rds.ca-central-1.amazonaws.com"
},
"eu-central-1" : {
"credentialScope" : {
"region" : "eu-central-1"
@ -1255,6 +1326,7 @@
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1628,6 +1700,7 @@
"forecast" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
@ -1746,6 +1819,8 @@
},
"groundstation" : {
"endpoints" : {
"eu-north-1" : { },
"me-south-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
@ -1964,6 +2039,7 @@
},
"iotsecuredtunneling" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -1975,6 +2051,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -2011,6 +2088,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -2042,16 +2120,20 @@
},
"kinesisanalytics" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -2059,11 +2141,20 @@
},
"kinesisvideo" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
@ -2202,6 +2293,7 @@
},
"mediaconnect" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2363,6 +2455,7 @@
},
"mq" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2370,6 +2463,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2397,6 +2491,8 @@
},
"hostname" : "mq-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -2602,6 +2698,26 @@
"isRegionalized" : false,
"partitionEndpoint" : "aws-global"
},
"outposts" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
"pinpoint" : {
"defaults" : {
"credentialScope" : {
@ -2641,6 +2757,7 @@
},
"polly" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2652,6 +2769,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -2743,6 +2861,7 @@
},
"ram" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2754,6 +2873,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -2902,6 +3022,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2909,6 +3030,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2998,6 +3120,13 @@
"hostname" : "s3.ap-southeast-2.amazonaws.com",
"signatureVersions" : [ "s3", "s3v4" ]
},
"aws-global" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "s3.amazonaws.com",
"signatureVersions" : [ "s3", "s3v4" ]
},
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
@ -3020,7 +3149,7 @@
"signatureVersions" : [ "s3", "s3v4" ]
},
"us-east-1" : {
"hostname" : "s3.amazonaws.com",
"hostname" : "s3.us-east-1.amazonaws.com",
"signatureVersions" : [ "s3", "s3v4" ]
},
"us-east-2" : { },
@ -3034,7 +3163,7 @@
}
},
"isRegionalized" : true,
"partitionEndpoint" : "us-east-1"
"partitionEndpoint" : "aws-global"
},
"s3-control" : {
"defaults" : {
@ -4032,6 +4161,16 @@
"cn-northwest-1" : { }
}
},
"appsync" : {
"endpoints" : {
"cn-north-1" : { }
}
},
"athena" : {
"endpoints" : {
"cn-northwest-1" : { }
}
},
"autoscaling" : {
"defaults" : {
"protocols" : [ "http", "https" ]
@ -4166,6 +4305,12 @@
"cn-northwest-1" : { }
}
},
"elasticfilesystem" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"elasticloadbalancing" : {
"defaults" : {
"protocols" : [ "https" ]
@ -4230,6 +4375,12 @@
},
"isRegionalized" : true
},
"health" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"iam" : {
"endpoints" : {
"aws-cn-global" : {
@ -4302,6 +4453,16 @@
"cn-northwest-1" : { }
}
},
"neptune" : {
"endpoints" : {
"cn-northwest-1" : {
"credentialScope" : {
"region" : "cn-northwest-1"
},
"hostname" : "rds.cn-northwest-1.amazonaws.com.cn"
}
}
},
"polly" : {
"endpoints" : {
"cn-northwest-1" : { }
@ -4351,6 +4512,25 @@
}
}
},
"secretsmanager" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"serverlessrepo" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"cn-north-1" : {
"protocols" : [ "https" ]
},
"cn-northwest-1" : {
"protocols" : [ "https" ]
}
}
},
"sms" : {
"endpoints" : {
"cn-north-1" : { },
@ -4395,7 +4575,8 @@
},
"storagegateway" : {
"endpoints" : {
"cn-north-1" : { }
"cn-north-1" : { },
"cn-northwest-1" : { }
}
},
"streams.dynamodb" : {
@ -4462,6 +4643,12 @@
"endpoints" : {
"cn-northwest-1" : { }
}
},
"xray" : {
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
}
}
}
}, {
@ -4483,6 +4670,12 @@
}
},
"services" : {
"access-analyzer" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"acm" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -4565,6 +4758,21 @@
}
}
},
"autoscaling-plans" : {
"defaults" : {
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"batch" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
"clouddirectory" : {
"endpoints" : {
"us-gov-west-1" : { }
@ -4636,6 +4844,11 @@
"us-gov-west-1" : { }
}
},
"comprehendmedical" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"config" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -4733,6 +4946,7 @@
},
"elasticfilesystem" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
@ -5170,6 +5384,17 @@
"us-gov-west-1" : { }
}
},
"support" : {
"endpoints" : {
"aws-us-gov-global" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "support.us-gov-west-1.amazonaws.com"
}
},
"partitionEndpoint" : "aws-us-gov-global"
},
"swf" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -5187,6 +5412,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
@ -5253,7 +5479,6 @@
},
"application-autoscaling" : {
"defaults" : {
"hostname" : "autoscaling.us-iso-east-1.c2s.ic.gov",
"protocols" : [ "http", "https" ]
},
"endpoints" : {
@ -5523,7 +5748,6 @@
"services" : {
"application-autoscaling" : {
"defaults" : {
"hostname" : "autoscaling.us-isob-east-1.sc2s.sgov.gov",
"protocols" : [ "http", "https" ]
},
"endpoints" : {

View file

@ -189,6 +189,22 @@
],
"documentation":"<p>Returns an array of <code>PolicySummary</code> objects in the response.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Retrieves the list of tags for the specified AWS resource. </p>"
},
"PutNotificationChannel":{
"name":"PutNotificationChannel",
"http":{
@ -220,6 +236,39 @@
{"shape":"InvalidTypeException"}
],
"documentation":"<p>Creates an AWS Firewall Manager policy.</p> <p>Firewall Manager provides the following types of policies: </p> <ul> <li> <p>A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources</p> </li> <li> <p>An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group</p> </li> <li> <p>A security group policy, which manages VPC security groups across your AWS organization. </p> </li> </ul> <p>Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can create multiple policies. You can create multiple policies for each type.</p> <p>You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see <a href=\"https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html\">CreateSubscription</a>.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds one or more tags to an AWS resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Removes one or more tags from an AWS resource.</p>"
}
},
"shapes":{
@ -617,6 +666,25 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager policy is the only AWS resource that supports tagging, so this ARN is a policy ARN..</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p>The tags associated with the resource.</p>"
}
}
},
"ManagedServiceData":{
"type":"string",
"max":1024,
@ -633,6 +701,7 @@
},
"PaginationToken":{
"type":"string",
"max":4096,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
@ -843,6 +912,10 @@
"Policy":{
"shape":"Policy",
"documentation":"<p>The details of the AWS Firewall Manager policy to be created.</p>"
},
"TagList":{
"shape":"TagList",
"documentation":"<p>The tags to add to the AWS resource.</p>"
}
}
},
@ -894,16 +967,27 @@
"required":["Key"],
"members":{
"Key":{
"shape":"TagKey",
"shape":"ResourceTagKey",
"documentation":"<p>The resource tag key.</p>"
},
"Value":{
"shape":"TagValue",
"shape":"ResourceTagValue",
"documentation":"<p>The resource tag value.</p>"
}
},
"documentation":"<p>The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see <a href=\"https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html\">Working with Tag Editor</a>.</p>"
},
"ResourceTagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"ResourceTagValue":{
"type":"string",
"max":256,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"ResourceTags":{
"type":"list",
"member":{"shape":"ResourceTag"},
@ -945,18 +1029,93 @@
"SECURITY_GROUPS_USAGE_AUDIT"
]
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive. </p>"
}
},
"documentation":"<p>A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource. </p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"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",
"TagList"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy is the only AWS resource that supports tagging, so this ARN is a policy ARN.</p>"
},
"TagList":{
"shape":"TagList",
"documentation":"<p>The tags to add to the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TimeStamp":{"type":"timestamp"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy is the only AWS resource that supports tagging, so this ARN is a policy ARN.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the tags to remove from the resource. </p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"ViolationReason":{
"type":"string",
"enum":[

View file

@ -28,7 +28,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves a forecast filtered by the supplied criteria.</p> <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p> <p>By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note>"
"documentation":"<p>Retrieves a forecast for a single item, filtered by the supplied criteria.</p> <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p> <p>By default, <code>QueryForecast</code> returns the complete date range for the filtered forecast. You can request a specific date range.</p> <p>To get the full forecast, use the <a href=\"https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html\">CreateForecastExportJob</a> operation.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note>"
}
},
"shapes":{
@ -60,11 +60,7 @@
},
"documentation":"<p>The forecast value for a specific date. Part of the <a>Forecast</a> object.</p>"
},
"DateTime":{
"type":"string",
"max":20,
"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
},
"DateTime":{"type":"string"},
"Double":{"type":"double"},
"ErrorMessage":{"type":"string"},
"Filters":{
@ -79,7 +75,7 @@
"members":{
"Predictions":{
"shape":"Predictions",
"documentation":"<p>The forecast.</p> <p>The <i>string</i> of the string to array map is one of the following values:</p> <ul> <li> <p>mean</p> </li> <li> <p>p10</p> </li> <li> <p>p50</p> </li> <li> <p>p90</p> </li> </ul>"
"documentation":"<p>The forecast.</p> <p>The <i>string</i> of the string-to-array map is one of the following values:</p> <ul> <li> <p>p10</p> </li> <li> <p>p50</p> </li> <li> <p>p90</p> </li> </ul>"
}
},
"documentation":"<p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>"
@ -89,7 +85,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The value that you provided was invalid or too long.</p>",
"documentation":"<p>The value is invalid or is too long.</p>",
"exception":true
},
"InvalidNextTokenException":{
@ -131,15 +127,15 @@
},
"StartDate":{
"shape":"DateTime",
"documentation":"<p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example, \"1970-01-01T00:00:00Z.\"</p>"
"documentation":"<p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.</p>"
},
"EndDate":{
"shape":"DateTime",
"documentation":"<p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example, \"1970-01-01T00:00:00Z.\" </p>"
"documentation":"<p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. </p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>The filtering criteria to apply when retrieving the forecast. For example:</p> <ul> <li> <p>To get a forecast for a specific item specify the following:</p> <p> <code>{\"item_id\" : \"client_1\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for a specific item sold in a specific location, specify the following:</p> <p> <code>{\"item_id\" : \"client_1\", \"location\" : \"ny\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for all blue items sold in a specific location, specify the following:</p> <p> <code>{ \"location\" : \"ny\", \"color\":\"blue\"}</code> </p> </li> </ul> <p>To get the full forecast, use the operation.</p>"
"documentation":"<p>The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for <code>client_21</code> in the electricity usage dataset, specify the following:</p> <p> <code>{\"item_id\" : \"client_21\"}</code> </p> <p>To get the full forecast, use the <a href=\"https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html\">CreateForecastExportJob</a> operation.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -180,11 +176,7 @@
"type":"list",
"member":{"shape":"DataPoint"}
},
"Timestamp":{
"type":"string",
"max":20,
"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
}
"Timestamp":{"type":"string"}
},
"documentation":"<p>Provides APIs for creating and managing Amazon Forecast resources.</p>"
}

View file

@ -12,6 +12,24 @@
"uid":"fsx-2018-03-01"
},
"operations":{
"CancelDataRepositoryTask":{
"name":"CancelDataRepositoryTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelDataRepositoryTaskRequest"},
"output":{"shape":"CancelDataRepositoryTaskResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"UnsupportedOperation"},
{"shape":"DataRepositoryTaskNotFound"},
{"shape":"DataRepositoryTaskEnded"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel a task, Amazon FSx does the following.</p> <ul> <li> <p>Any files that FSx has already exported are not reverted.</p> </li> <li> <p>FSx continues to export any files that are \"in-flight\" when the cancel operation is received.</p> </li> <li> <p>FSx does not export any files that have not yet been exported.</p> </li> </ul>",
"idempotent":true
},
"CreateBackup":{
"name":"CreateBackup",
"http":{
@ -32,6 +50,26 @@
"documentation":"<p>Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.</p> <p>If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns <code>IncompatibleParameterError</code>. If a backup with the specified client request token doesn't exist, <code>CreateBackup</code> does the following: </p> <ul> <li> <p>Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the backup.</p> </li> </ul> <p>By using the idempotent operation, you can retry a <code>CreateBackup</code> operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.</p> <p>The <code>CreateFileSystem</code> operation returns while the backup's lifecycle state is still <code>CREATING</code>. You can check the file system creation status by calling the <a>DescribeBackups</a> operation, which returns the backup state along with other information.</p> <note> <p/> </note>",
"idempotent":true
},
"CreateDataRepositoryTask":{
"name":"CreateDataRepositoryTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDataRepositoryTaskRequest"},
"output":{"shape":"CreateDataRepositoryTaskResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"UnsupportedOperation"},
{"shape":"FileSystemNotFound"},
{"shape":"IncompatibleParameterError"},
{"shape":"ServiceLimitExceeded"},
{"shape":"InternalServerError"},
{"shape":"DataRepositoryTaskExecuting"}
],
"documentation":"<p>Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repository. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to its linked data repository. A <code>CreateDataRepositoryTask</code> operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html\">Using Data Repository Tasks</a>. To learn more about linking a data repository to your file system, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/getting-started-step1.html\">Step 1: Create Your Amazon FSx for Lustre File System</a>.</p>",
"idempotent":true
},
"CreateFileSystem":{
"name":"CreateFileSystem",
"http":{
@ -107,7 +145,7 @@
{"shape":"ServiceLimitExceeded"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.</p> <p>By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.</p> <p>The <code>DeleteFileSystem</code> action returns while the file system has the <code>DELETING</code> status. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the <a>DescribeFileSystems</a> returns a <code>FileSystemNotFound</code> error.</p> <important> <p>The data in a deleted file system is also deleted and can't be recovered by any means.</p> </important>",
"documentation":"<p>Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.</p> <p>By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.</p> <p>The <code>DeleteFileSystem</code> action returns while the file system has the <code>DELETING</code> status. You can check the file system deletion status by calling the <a>DescribeFileSystems</a> action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the <a>DescribeFileSystems</a> returns a <code>FileSystemNotFound</code> error.</p> <note> <p>Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a <code>PENDING</code> or <code>EXECUTING</code> state.</p> </note> <important> <p>The data in a deleted file system is also deleted and can't be recovered by any means.</p> </important>",
"idempotent":true
},
"DescribeBackups":{
@ -126,6 +164,22 @@
],
"documentation":"<p>Returns the description of specific Amazon FSx for Windows File Server backups, if a <code>BackupIds</code> value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.</p> <p>When retrieving all backups, you can optionally specify the <code>MaxResults</code> parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p> <p>This action is used in an iterative process to retrieve a list of your backups. <code>DescribeBackups</code> is called first without a <code>NextToken</code>value. Then the action continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>.</p> <p>When using this action, keep the following in mind:</p> <ul> <li> <p>The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of backups returned in the response of one <code>DescribeBackups</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified.</p> </li> </ul>"
},
"DescribeDataRepositoryTasks":{
"name":"DescribeDataRepositoryTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDataRepositoryTasksRequest"},
"output":{"shape":"DescribeDataRepositoryTasksResponse"},
"errors":[
{"shape":"BadRequest"},
{"shape":"FileSystemNotFound"},
{"shape":"DataRepositoryTaskNotFound"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more <code>TaskIds</code> values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling.</p> <p>When retrieving all tasks, you can paginate the response by using the optional <code>MaxResults</code> parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p>"
},
"DescribeFileSystems":{
"name":"DescribeFileSystems",
"http":{
@ -262,11 +316,17 @@
"INVALID_DOMAIN_STAGE"
]
},
"ActiveDirectoryFullyQualifiedName":{"type":"string"},
"ActiveDirectoryFullyQualifiedName":{
"type":"string",
"max":255,
"min":1,
"pattern":"^.{1,255}$"
},
"ArchivePath":{
"type":"string",
"max":900,
"min":3
"min":3,
"pattern":"^.{3,900}$"
},
"AutomaticBackupRetentionDays":{
"type":"integer",
@ -307,7 +367,7 @@
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.</p>"
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup of the Amazon FSx for Windows file system's data at rest. Amazon FSx for Lustre does not support KMS encryption.</p>"
},
"ResourceARN":{
"shape":"ResourceARN",
@ -411,12 +471,59 @@
"documentation":"<p>A generic error indicating a failure with a client request.</p>",
"exception":true
},
"CancelDataRepositoryTaskRequest":{
"type":"structure",
"required":["TaskId"],
"members":{
"TaskId":{
"shape":"TaskId",
"documentation":"<p>Specifies the data repository task to cancel.</p>"
}
},
"documentation":"<p>Cancels a data repository task.</p>"
},
"CancelDataRepositoryTaskResponse":{
"type":"structure",
"members":{
"Lifecycle":{
"shape":"DataRepositoryTaskLifecycle",
"documentation":"<p>The lifecycle status of the data repository task, as follows:</p> <ul> <li> <p> <code>PENDING</code> - Amazon FSx has not started the task.</p> </li> <li> <p> <code>EXECUTING</code> - Amazon FSx is processing the task.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The <a>DataRepositoryTaskFailureDetails</a> property provides more information about task failures.</p> </li> <li> <p> <code>SUCCEEDED</code> - FSx completed the task successfully.</p> </li> <li> <p> <code>CANCELED</code> - Amazon FSx canceled the task and it did not complete.</p> </li> <li> <p> <code>CANCELING</code> - FSx is in process of canceling the task.</p> </li> </ul>"
},
"TaskId":{
"shape":"TaskId",
"documentation":"<p>The ID of the task being canceled.</p>"
}
}
},
"ClientRequestToken":{
"type":"string",
"documentation":"<p>(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
"max":255,
"max":63,
"min":1,
"pattern":"[A-za-z0-9_.-]{0,255}$"
"pattern":"[A-za-z0-9_.-]{0,63}$"
},
"CompletionReport":{
"type":"structure",
"required":["Enabled"],
"members":{
"Enabled":{
"shape":"Flag",
"documentation":"<p>Set <code>Enabled</code> to <code>True</code> to generate a <code>CompletionReport</code> when the task completes. If set to <code>true</code>, then you need to provide a report <code>Scope</code>, <code>Path</code>, and <code>Format</code>. Set <code>Enabled</code> to <code>False</code> if you do not want a <code>CompletionReport</code> generated when the task completes.</p>"
},
"Path":{
"shape":"ArchivePath",
"documentation":"<p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The <code>Path</code> you provide must be located within the file systems ExportPath. An example <code>Path</code> value is \"s3://myBucket/myExportPath/optionalPrefix\". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a file system's <code>ExportPath</code>, see . </p>"
},
"Format":{
"shape":"ReportFormat",
"documentation":"<p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the format of the <code>CompletionReport</code>. <code>REPORT_CSV_20191124</code> is the only format currently supported. When <code>Format</code> is set to <code>REPORT_CSV_20191124</code>, the <code>CompletionReport</code> is provided in CSV format, and is delivered to <code>{path}/task-{id}/failures.csv</code>. </p>"
},
"Scope":{
"shape":"ReportScope",
"documentation":"<p>Required if <code>Enabled</code> is set to <code>true</code>. Specifies the scope of the <code>CompletionReport</code>; <code>FAILED_FILES_ONLY</code> is the only scope currently supported. When <code>Scope</code> is set to <code>FAILED_FILES_ONLY</code>, the <code>CompletionReport</code> only contains information about files that the data repository task failed to process.</p>"
}
},
"documentation":"<p>Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report <code>Scope</code> parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report <code>Path</code> parameter. You can specify whether or not a report gets generated for a task using the <code>Enabled</code> parameter.</p>"
},
"CreateBackupRequest":{
"type":"structure",
@ -448,6 +555,43 @@
},
"documentation":"<p>The response object for the <code>CreateBackup</code> operation.</p>"
},
"CreateDataRepositoryTaskRequest":{
"type":"structure",
"required":[
"Type",
"FileSystemId",
"Report"
],
"members":{
"Type":{
"shape":"DataRepositoryTaskType",
"documentation":"<p>Specifies the type of data repository task to create.</p>"
},
"Paths":{
"shape":"DataRepositoryTaskPaths",
"documentation":"<p>(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The default path is the file system root directory.</p>"
},
"FileSystemId":{"shape":"FileSystemId"},
"Report":{
"shape":"CompletionReport",
"documentation":"<p>Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the <code>Scope</code> parameter. </p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"idempotencyToken":true
},
"Tags":{"shape":"Tags"}
}
},
"CreateDataRepositoryTaskResponse":{
"type":"structure",
"members":{
"DataRepositoryTask":{
"shape":"DataRepositoryTask",
"documentation":"<p>The description of the data repository task that you just created.</p>"
}
}
},
"CreateFileSystemFromBackupRequest":{
"type":"structure",
"required":[
@ -640,6 +784,177 @@
},
"documentation":"<p>The data repository configuration object for Lustre file systems returned in the response of the <code>CreateFileSystem</code> operation.</p>"
},
"DataRepositoryTask":{
"type":"structure",
"required":[
"TaskId",
"Lifecycle",
"Type",
"CreationTime",
"FileSystemId"
],
"members":{
"TaskId":{
"shape":"TaskId",
"documentation":"<p>The system-generated, unique 17-digit ID of the data repository task.</p>"
},
"Lifecycle":{
"shape":"DataRepositoryTaskLifecycle",
"documentation":"<p>The lifecycle status of the data repository task, as follows:</p> <ul> <li> <p> <code>PENDING</code> - Amazon FSx has not started the task.</p> </li> <li> <p> <code>EXECUTING</code> - Amazon FSx is processing the task.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The <a>DataRepositoryTaskFailureDetails</a> property provides more information about task failures.</p> </li> <li> <p> <code>SUCCEEDED</code> - FSx completed the task successfully.</p> </li> <li> <p> <code>CANCELED</code> - Amazon FSx canceled the task and it did not complete.</p> </li> <li> <p> <code>CANCELING</code> - FSx is in process of canceling the task.</p> </li> </ul> <note> <p>You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the <code>PENDING</code> or <code>EXECUTING</code> states. Please retry when the data repository task is finished (with a status of <code>CANCELED</code>, <code>SUCCEEDED</code>, or <code>FAILED</code>). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.</p> </note>"
},
"Type":{
"shape":"DataRepositoryTaskType",
"documentation":"<p>The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.</p>"
},
"CreationTime":{"shape":"CreationTime"},
"StartTime":{
"shape":"StartTime",
"documentation":"<p>The time that Amazon FSx began processing the task.</p>"
},
"EndTime":{
"shape":"EndTime",
"documentation":"<p>The time that Amazon FSx completed processing the task, populated after the task is complete.</p>"
},
"ResourceARN":{"shape":"ResourceARN"},
"Tags":{"shape":"Tags"},
"FileSystemId":{"shape":"FileSystemId"},
"Paths":{
"shape":"DataRepositoryTaskPaths",
"documentation":"<p>An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.</p> <p>(Default) If <code>Paths</code> is not specified, Amazon FSx uses the file system root directory.</p>"
},
"FailureDetails":{
"shape":"DataRepositoryTaskFailureDetails",
"documentation":"<p>Failure message describing why the task failed, it is populated only when <code>Lifecycle</code> is set to <code>FAILED</code>.</p>"
},
"Status":{
"shape":"DataRepositoryTaskStatus",
"documentation":"<p>Provides the status of the number of files that the task has processed successfully and failed to process.</p>"
},
"Report":{"shape":"CompletionReport"}
},
"documentation":"<p>A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.</p>"
},
"DataRepositoryTaskEnded":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The data repository task could not be canceled because the task has already ended.</p>",
"exception":true
},
"DataRepositoryTaskExecuting":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>An existing data repository task is currently executing on the file system. Wait until the existing task has completed, then create the new task.</p>",
"exception":true
},
"DataRepositoryTaskFailureDetails":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Provides information about why a data repository task failed. Only populated when the task <code>Lifecycle</code> is set to <code>FAILED</code>.</p>"
},
"DataRepositoryTaskFilter":{
"type":"structure",
"members":{
"Name":{
"shape":"DataRepositoryTaskFilterName",
"documentation":"<p>Name of the task property to use in filtering the tasks returned in the response.</p> <ul> <li> <p>Use <code>file-system-id</code> to retrieve data repository tasks for specific file systems.</p> </li> <li> <p>Use <code>task-lifecycle</code> to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.</p> </li> </ul>"
},
"Values":{
"shape":"DataRepositoryTaskFilterValues",
"documentation":"<p>Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.</p>"
}
},
"documentation":"<p>(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter <code>Name</code>, and one or more <code>Values</code> for the filter.</p>"
},
"DataRepositoryTaskFilterName":{
"type":"string",
"enum":[
"file-system-id",
"task-lifecycle"
]
},
"DataRepositoryTaskFilterValue":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$"
},
"DataRepositoryTaskFilterValues":{
"type":"list",
"member":{"shape":"DataRepositoryTaskFilterValue"},
"max":20
},
"DataRepositoryTaskFilters":{
"type":"list",
"member":{"shape":"DataRepositoryTaskFilter"},
"max":3
},
"DataRepositoryTaskLifecycle":{
"type":"string",
"enum":[
"PENDING",
"EXECUTING",
"FAILED",
"SUCCEEDED",
"CANCELED",
"CANCELING"
]
},
"DataRepositoryTaskNotFound":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The data repository task or tasks you specified could not be found.</p>",
"exception":true
},
"DataRepositoryTaskPath":{
"type":"string",
"max":4096,
"min":0,
"pattern":"^.{0,4096}$"
},
"DataRepositoryTaskPaths":{
"type":"list",
"member":{"shape":"DataRepositoryTaskPath"},
"max":100
},
"DataRepositoryTaskStatus":{
"type":"structure",
"members":{
"TotalCount":{
"shape":"TotalCount",
"documentation":"<p>The total number of files that the task will process. While a task is executing, the sum of <code>SucceededCount</code> plus <code>FailedCount</code> may not equal <code>TotalCount</code>. When the task is complete, <code>TotalCount</code> equals the sum of <code>SucceededCount</code> plus <code>FailedCount</code>.</p>"
},
"SucceededCount":{
"shape":"SucceededCount",
"documentation":"<p>A running total of the number of files that the task has successfully processed.</p>"
},
"FailedCount":{
"shape":"FailedCount",
"documentation":"<p>A running total of the number of files that the task failed to process.</p>"
},
"LastUpdatedTime":{
"shape":"LastUpdatedTime",
"documentation":"<p>The time at which the task status was last updated.</p>"
}
},
"documentation":"<p>Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.</p>"
},
"DataRepositoryTaskType":{
"type":"string",
"enum":["EXPORT_TO_REPOSITORY"]
},
"DataRepositoryTasks":{
"type":"list",
"member":{"shape":"DataRepositoryTask"},
"max":50
},
"DeleteBackupRequest":{
"type":"structure",
"required":["BackupId"],
@ -766,6 +1081,31 @@
},
"documentation":"<p>Response object for <code>DescribeBackups</code> operation.</p>"
},
"DescribeDataRepositoryTasksRequest":{
"type":"structure",
"members":{
"TaskIds":{
"shape":"TaskIds",
"documentation":"<p>(Optional) IDs of the tasks whose descriptions you want to retrieve (String).</p>"
},
"Filters":{
"shape":"DataRepositoryTaskFilters",
"documentation":"<p>(Optional) You can use filters to narrow the <code>DescribeDataRepositoryTasks</code> response to include just tasks for specific file systems, or tasks in a specific lifecycle state.</p>"
},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeDataRepositoryTasksResponse":{
"type":"structure",
"members":{
"DataRepositoryTasks":{
"shape":"DataRepositoryTasks",
"documentation":"<p>The collection of data repository task descriptions returned.</p>"
},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeFileSystemsRequest":{
"type":"structure",
"members":{
@ -808,12 +1148,14 @@
"type":"string",
"max":256,
"min":1,
"pattern":"^.{1,256}$",
"sensitive":true
},
"DirectoryUserName":{
"type":"string",
"max":256,
"min":1
"min":1,
"pattern":"^.{1,256}$"
},
"DnsIps":{
"type":"list",
@ -821,12 +1163,14 @@
"max":2,
"min":1
},
"EndTime":{"type":"timestamp"},
"ErrorMessage":{
"type":"string",
"documentation":"<p>A detailed error message.</p>",
"max":256,
"min":1
},
"FailedCount":{"type":"long"},
"FileSystem":{
"type":"structure",
"members":{
@ -873,7 +1217,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.</p>"
"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>"
},
"ResourceARN":{
"shape":"ResourceARN",
@ -894,7 +1238,8 @@
"FileSystemAdministratorsGroupName":{
"type":"string",
"max":256,
"min":1
"min":1,
"pattern":"^.{1,256}$"
},
"FileSystemFailureDetails":{
"type":"structure",
@ -1059,15 +1404,18 @@
},
"IpAddress":{
"type":"string",
"max":15,
"min":7,
"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])$"
},
"KmsKeyId":{
"type":"string",
"documentation":"<p>The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see <a href=\"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 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>",
"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:\\/_-]+$"
},
"LastUpdatedTime":{"type":"timestamp"},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceARN"],
@ -1172,7 +1520,8 @@
"OrganizationalUnitDistinguishedName":{
"type":"string",
"max":2000,
"min":1
"min":1,
"pattern":"^.{1,2000}$"
},
"Parameter":{
"type":"string",
@ -1185,6 +1534,14 @@
"max":100,
"min":0
},
"ReportFormat":{
"type":"string",
"enum":["REPORT_CSV_20191124"]
},
"ReportScope":{
"type":"string",
"enum":["FAILED_FILES_ONLY"]
},
"ResourceARN":{
"type":"string",
"documentation":"<p>The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
@ -1288,7 +1645,7 @@
},
"DnsIps":{
"shape":"DnsIps",
"documentation":"<p>A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (Iv4) address ranges, as specified in <a href=\"http://www.faqs.org/rfcs/rfc1918.html\">RFC 1918</a>:</p> <ul> <li> <p>10.0.0.0 - 10.255.255.255 (10/8 prefix)</p> </li> <li> <p>172.16.0.0 - 172.31.255.255 (172.16/12 prefix)</p> </li> <li> <p>192.168.0.0 - 192.168.255.255 (192.168/16 prefix)</p> </li> </ul>"
"documentation":"<p>A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (IPv4) address ranges, as specified in <a href=\"http://www.faqs.org/rfcs/rfc1918.html\">RFC 1918</a>:</p> <ul> <li> <p>10.0.0.0 - 10.255.255.255 (10/8 prefix)</p> </li> <li> <p>172.16.0.0 - 172.31.255.255 (172.16/12 prefix)</p> </li> <li> <p>192.168.0.0 - 192.168.255.255 (192.168/16 prefix)</p> </li> </ul>"
}
},
"documentation":"<p>The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.</p>"
@ -1334,10 +1691,11 @@
"documentation":"<p>An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support. </p>",
"exception":true
},
"StartTime":{"type":"timestamp"},
"StorageCapacity":{
"type":"integer",
"documentation":"<p>The storage capacity for your Amazon FSx file system, in gibibytes.</p>",
"min":1
"min":0
},
"SubnetId":{
"type":"string",
@ -1352,6 +1710,7 @@
"documentation":"<p>A list of subnet IDs. Currently, you can specify only one subnet ID in a call to the <code>CreateFileSystem</code> operation.</p>",
"max":50
},
"SucceededCount":{"type":"long"},
"Tag":{
"type":"structure",
"members":{
@ -1370,7 +1729,8 @@
"type":"string",
"documentation":"<p>A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.</p>",
"max":128,
"min":1
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeys":{
"type":"list",
@ -1407,7 +1767,8 @@
"type":"string",
"documentation":"<p>A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.</p>",
"max":256,
"min":0
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"Tags":{
"type":"list",
@ -1416,12 +1777,24 @@
"max":50,
"min":1
},
"TaskId":{
"type":"string",
"max":128,
"min":12,
"pattern":"^(task-[0-9a-f]{17,})$"
},
"TaskIds":{
"type":"list",
"member":{"shape":"TaskId"},
"max":50
},
"TotalCount":{"type":"long"},
"UnsupportedOperation":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>An error occured.</p>",
"documentation":"<p>The requested operation is not supported for this resource or API.</p>",
"exception":true
},
"UntagResourceRequest":{

File diff suppressed because one or more lines are too long

View file

@ -1,1035 +1,676 @@
{
"version": "2.0",
"metadata": {
"apiVersion": "2019-05-23",
"endpointPrefix": "groundstation",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceFullName": "AWS Ground Station",
"serviceId": "GroundStation",
"signatureVersion": "v4",
"signingName": "groundstation",
"uid": "groundstation-2019-05-23"
"version":"2.0",
"metadata":{
"apiVersion":"2019-05-23",
"endpointPrefix":"groundstation",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Ground Station",
"serviceId":"GroundStation",
"signatureVersion":"v4",
"signingName":"groundstation",
"uid":"groundstation-2019-05-23"
},
"documentation": "<p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that\n enables you to control satellite communications, downlink and process satellite data, and\n scale your satellite operations efficiently and cost-effectively without having\n to build or manage your own ground station infrastructure.</p>",
"operations": {
"CancelContact": {
"name": "CancelContact",
"http": {
"method": "DELETE",
"requestUri": "/contact/{contactId}",
"responseCode": 200
"operations":{
"CancelContact":{
"name":"CancelContact",
"http":{
"method":"DELETE",
"requestUri":"/contact/{contactId}",
"responseCode":200
},
"input": {
"shape": "CancelContactRequest"
},
"output": {
"shape": "ContactIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"CancelContactRequest"},
"output":{"shape":"ContactIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Cancels a contact with a specified contact ID.</p>",
"idempotent": true
"documentation":"<p>Cancels a contact with a specified contact ID.</p>",
"idempotent":true
},
"CreateConfig": {
"name": "CreateConfig",
"http": {
"method": "POST",
"requestUri": "/config",
"responseCode": 200
"CreateConfig":{
"name":"CreateConfig",
"http":{
"method":"POST",
"requestUri":"/config",
"responseCode":200
},
"input": {
"shape": "CreateConfigRequest"
},
"output": {
"shape": "ConfigIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"CreateConfigRequest"},
"output":{"shape":"ConfigIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p>\n <p>Only one type of <code>configData</code> can be specified.</p>"
"documentation":"<p>Creates a <code>Config</code> with the specified <code>configData</code> parameters.</p> <p>Only one type of <code>configData</code> can be specified.</p>"
},
"CreateDataflowEndpointGroup": {
"name": "CreateDataflowEndpointGroup",
"http": {
"method": "POST",
"requestUri": "/dataflowEndpointGroup",
"responseCode": 200
"CreateDataflowEndpointGroup":{
"name":"CreateDataflowEndpointGroup",
"http":{
"method":"POST",
"requestUri":"/dataflowEndpointGroup",
"responseCode":200
},
"input": {
"shape": "CreateDataflowEndpointGroupRequest"
},
"output": {
"shape": "DataflowEndpointGroupIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"CreateDataflowEndpointGroupRequest"},
"output":{"shape":"DataflowEndpointGroupIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p>\n <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code> \n to specify which endpoints to use during a contact.</p> \n <p>When a contact uses multiple <code>DataflowEndpointConfig</code> objects, each <code>Config</code> \n must match a <code>DataflowEndpoint</code> in the same group.</p>"
"documentation":"<p>Creates a <code>DataflowEndpoint</code> group containing the specified list of <code>DataflowEndpoint</code> objects.</p> <p>The <code>name</code> field in each endpoint is used in your mission profile <code>DataflowEndpointConfig</code> to specify which endpoints to use during a contact.</p> <p>When a contact uses multiple <code>DataflowEndpointConfig</code> objects, each <code>Config</code> must match a <code>DataflowEndpoint</code> in the same group.</p>"
},
"CreateMissionProfile": {
"name": "CreateMissionProfile",
"http": {
"method": "POST",
"requestUri": "/missionprofile",
"responseCode": 200
"CreateMissionProfile":{
"name":"CreateMissionProfile",
"http":{
"method":"POST",
"requestUri":"/missionprofile",
"responseCode":200
},
"input": {
"shape": "CreateMissionProfileRequest"
},
"output": {
"shape": "MissionProfileIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"CreateMissionProfileRequest"},
"output":{"shape":"MissionProfileIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Creates a mission profile.</p>\n <p>\n <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings\n has two elements: a <i>from ARN</i> and a <i>to ARN</i>.</p>"
"documentation":"<p>Creates a mission profile.</p> <p> <code>dataflowEdges</code> is a list of lists of strings. Each lower level list of strings has two elements: a <i>from</i> ARN and a <i>to</i> ARN.</p>"
},
"DeleteConfig": {
"name": "DeleteConfig",
"http": {
"method": "DELETE",
"requestUri": "/config/{configType}/{configId}",
"responseCode": 200
"DeleteConfig":{
"name":"DeleteConfig",
"http":{
"method":"DELETE",
"requestUri":"/config/{configType}/{configId}",
"responseCode":200
},
"input": {
"shape": "DeleteConfigRequest"
},
"output": {
"shape": "ConfigIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"DeleteConfigRequest"},
"output":{"shape":"ConfigIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Deletes a <code>Config</code>.</p>",
"idempotent": true
"documentation":"<p>Deletes a <code>Config</code>.</p>",
"idempotent":true
},
"DeleteDataflowEndpointGroup": {
"name": "DeleteDataflowEndpointGroup",
"http": {
"method": "DELETE",
"requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}",
"responseCode": 200
"DeleteDataflowEndpointGroup":{
"name":"DeleteDataflowEndpointGroup",
"http":{
"method":"DELETE",
"requestUri":"/dataflowEndpointGroup/{dataflowEndpointGroupId}",
"responseCode":200
},
"input": {
"shape": "DeleteDataflowEndpointGroupRequest"
},
"output": {
"shape": "DataflowEndpointGroupIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"DeleteDataflowEndpointGroupRequest"},
"output":{"shape":"DataflowEndpointGroupIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Deletes a dataflow endpoint group.</p>",
"idempotent": true
"documentation":"<p>Deletes a dataflow endpoint group.</p>",
"idempotent":true
},
"DeleteMissionProfile": {
"name": "DeleteMissionProfile",
"http": {
"method": "DELETE",
"requestUri": "/missionprofile/{missionProfileId}",
"responseCode": 200
"DeleteMissionProfile":{
"name":"DeleteMissionProfile",
"http":{
"method":"DELETE",
"requestUri":"/missionprofile/{missionProfileId}",
"responseCode":200
},
"input": {
"shape": "DeleteMissionProfileRequest"
},
"output": {
"shape": "MissionProfileIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"DeleteMissionProfileRequest"},
"output":{"shape":"MissionProfileIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Deletes a mission profile.</p>",
"idempotent": true
"documentation":"<p>Deletes a mission profile.</p>",
"idempotent":true
},
"DescribeContact": {
"name": "DescribeContact",
"http": {
"method": "GET",
"requestUri": "/contact/{contactId}",
"responseCode": 200
"DescribeContact":{
"name":"DescribeContact",
"http":{
"method":"GET",
"requestUri":"/contact/{contactId}",
"responseCode":200
},
"input": {
"shape": "DescribeContactRequest"
},
"output": {
"shape": "DescribeContactResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"DescribeContactRequest"},
"output":{"shape":"DescribeContactResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Describes an existing contact.</p>"
"documentation":"<p>Describes an existing contact.</p>"
},
"GetConfig": {
"name": "GetConfig",
"http": {
"method": "GET",
"requestUri": "/config/{configType}/{configId}",
"responseCode": 200
"GetConfig":{
"name":"GetConfig",
"http":{
"method":"GET",
"requestUri":"/config/{configType}/{configId}",
"responseCode":200
},
"input": {
"shape": "GetConfigRequest"
},
"output": {
"shape": "GetConfigResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"GetConfigRequest"},
"output":{"shape":"GetConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns <code>Config</code> information.</p>\n <p>Only one <code>Config</code> response can be returned.</p>"
"documentation":"<p>Returns <code>Config</code> information.</p> <p>Only one <code>Config</code> response can be returned.</p>"
},
"GetDataflowEndpointGroup": {
"name": "GetDataflowEndpointGroup",
"http": {
"method": "GET",
"requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}",
"responseCode": 200
"GetDataflowEndpointGroup":{
"name":"GetDataflowEndpointGroup",
"http":{
"method":"GET",
"requestUri":"/dataflowEndpointGroup/{dataflowEndpointGroupId}",
"responseCode":200
},
"input": {
"shape": "GetDataflowEndpointGroupRequest"
},
"output": {
"shape": "GetDataflowEndpointGroupResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"GetDataflowEndpointGroupRequest"},
"output":{"shape":"GetDataflowEndpointGroupResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns the dataflow endpoint group.</p>"
"documentation":"<p>Returns the dataflow endpoint group.</p>"
},
"GetMissionProfile": {
"name": "GetMissionProfile",
"http": {
"method": "GET",
"requestUri": "/missionprofile/{missionProfileId}",
"responseCode": 200
"GetMinuteUsage":{
"name":"GetMinuteUsage",
"http":{
"method":"POST",
"requestUri":"/minute-usage",
"responseCode":200
},
"input": {
"shape": "GetMissionProfileRequest"
},
"output": {
"shape": "GetMissionProfileResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"GetMinuteUsageRequest"},
"output":{"shape":"GetMinuteUsageResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a mission profile.</p>"
"documentation":"<p>Returns the number of minutes used by account.</p>"
},
"ListConfigs": {
"name": "ListConfigs",
"http": {
"method": "GET",
"requestUri": "/config",
"responseCode": 200
"GetMissionProfile":{
"name":"GetMissionProfile",
"http":{
"method":"GET",
"requestUri":"/missionprofile/{missionProfileId}",
"responseCode":200
},
"input": {
"shape": "ListConfigsRequest"
},
"output": {
"shape": "ListConfigsResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"GetMissionProfileRequest"},
"output":{"shape":"GetMissionProfileResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of <code>Config</code> objects.</p>"
"documentation":"<p>Returns a mission profile.</p>"
},
"ListContacts": {
"name": "ListContacts",
"http": {
"method": "POST",
"requestUri": "/contacts",
"responseCode": 200
"GetSatellite":{
"name":"GetSatellite",
"http":{
"method":"GET",
"requestUri":"/satellite/{satelliteId}",
"responseCode":200
},
"input": {
"shape": "ListContactsRequest"
},
"output": {
"shape": "ListContactsResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"GetSatelliteRequest"},
"output":{"shape":"GetSatelliteResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of contacts.</p>\n <p>If <code>statusList</code> contains AVAILABLE, the request must include\n <code>groundstation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>.\n </p>"
"documentation":"<p>Returns a satellite.</p>"
},
"ListDataflowEndpointGroups": {
"name": "ListDataflowEndpointGroups",
"http": {
"method": "GET",
"requestUri": "/dataflowEndpointGroup",
"responseCode": 200
"ListConfigs":{
"name":"ListConfigs",
"http":{
"method":"GET",
"requestUri":"/config",
"responseCode":200
},
"input": {
"shape": "ListDataflowEndpointGroupsRequest"
},
"output": {
"shape": "ListDataflowEndpointGroupsResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListConfigsRequest"},
"output":{"shape":"ListConfigsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of <code>DataflowEndpoint</code> groups.</p>"
"documentation":"<p>Returns a list of <code>Config</code> objects.</p>"
},
"ListMissionProfiles": {
"name": "ListMissionProfiles",
"http": {
"method": "GET",
"requestUri": "/missionprofile",
"responseCode": 200
"ListContacts":{
"name":"ListContacts",
"http":{
"method":"POST",
"requestUri":"/contacts",
"responseCode":200
},
"input": {
"shape": "ListMissionProfilesRequest"
},
"output": {
"shape": "ListMissionProfilesResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListContactsRequest"},
"output":{"shape":"ListContactsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of mission profiles.</p>"
"documentation":"<p>Returns a list of contacts.</p> <p>If <code>statusList</code> contains AVAILABLE, the request must include <code>groundStation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>. </p>"
},
"ReserveContact": {
"name": "ReserveContact",
"http": {
"method": "POST",
"requestUri": "/contact",
"responseCode": 200
"ListDataflowEndpointGroups":{
"name":"ListDataflowEndpointGroups",
"http":{
"method":"GET",
"requestUri":"/dataflowEndpointGroup",
"responseCode":200
},
"input": {
"shape": "ReserveContactRequest"
},
"output": {
"shape": "ContactIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListDataflowEndpointGroupsRequest"},
"output":{"shape":"ListDataflowEndpointGroupsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Reserves a contact using specified parameters.</p>"
"documentation":"<p>Returns a list of <code>DataflowEndpoint</code> groups.</p>"
},
"UpdateConfig": {
"name": "UpdateConfig",
"http": {
"method": "PUT",
"requestUri": "/config/{configType}/{configId}",
"responseCode": 200
"ListGroundStations":{
"name":"ListGroundStations",
"http":{
"method":"GET",
"requestUri":"/groundstation",
"responseCode":200
},
"input": {
"shape": "UpdateConfigRequest"
},
"output": {
"shape": "ConfigIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListGroundStationsRequest"},
"output":{"shape":"ListGroundStationsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Updates the <code>Config</code> used when scheduling contacts.</p>\n <p>Updating a <code>Config</code> will not update the execution parameters\n for existing future contacts scheduled with this <code>Config</code>.</p>",
"idempotent": true
"documentation":"<p>Returns a list of ground stations. </p>"
},
"UpdateMissionProfile": {
"name": "UpdateMissionProfile",
"http": {
"method": "PUT",
"requestUri": "/missionprofile/{missionProfileId}",
"responseCode": 200
"ListMissionProfiles":{
"name":"ListMissionProfiles",
"http":{
"method":"GET",
"requestUri":"/missionprofile",
"responseCode":200
},
"input": {
"shape": "UpdateMissionProfileRequest"
},
"output": {
"shape": "MissionProfileIdResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListMissionProfilesRequest"},
"output":{"shape":"ListMissionProfilesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Updates a mission profile.</p>\n <p>Updating a mission profile will not update the execution parameters\n for existing future contacts.</p>",
"idempotent": true
"documentation":"<p>Returns a list of mission profiles.</p>"
},
"GetMinuteUsage": {
"name": "GetMinuteUsage",
"http": {
"method": "POST",
"requestUri": "/minute-usage",
"responseCode": 200
"ListSatellites":{
"name":"ListSatellites",
"http":{
"method":"GET",
"requestUri":"/satellite",
"responseCode":200
},
"input": {
"shape": "GetMinuteUsageRequest"
},
"output": {
"shape": "GetMinuteUsageResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListSatellitesRequest"},
"output":{"shape":"ListSatellitesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns the number of minutes used by account.</p>"
"documentation":"<p>Returns a list of satellites.</p>"
},
"GetSatellite": {
"name": "GetSatellite",
"http": {
"method": "GET",
"requestUri": "/satellite/{satelliteId}",
"responseCode": 200
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input": {
"shape": "GetSatelliteRequest"
},
"output": {
"shape": "GetSatelliteResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a satellite.</p>"
"documentation":"<p>Returns a list of tags for a specified resource.</p>"
},
"ListGroundStations": {
"name": "ListGroundStations",
"http": {
"method": "GET",
"requestUri": "/groundstation",
"responseCode": 200
"ReserveContact":{
"name":"ReserveContact",
"http":{
"method":"POST",
"requestUri":"/contact",
"responseCode":200
},
"input": {
"shape": "ListGroundStationsRequest"
},
"output": {
"shape": "ListGroundStationsResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"ReserveContactRequest"},
"output":{"shape":"ContactIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of ground stations. </p>"
"documentation":"<p>Reserves a contact using specified parameters.</p>"
},
"ListSatellites": {
"name": "ListSatellites",
"http": {
"method": "GET",
"requestUri": "/satellite",
"responseCode": 200
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input": {
"shape": "ListSatellitesRequest"
},
"output": {
"shape": "ListSatellitesResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of satellites.</p>"
"documentation":"<p>Assigns a tag to a resource.</p>"
},
"ListTagsForResource": {
"name": "ListTagsForResource",
"http": {
"method": "GET",
"requestUri": "/tags/{resourceArn}",
"responseCode": 200
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"output": {
"shape": "ListTagsForResourceResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Returns a list of tags or a specified resource.</p>"
"documentation":"<p>Deassigns a resource tag.</p>",
"idempotent":true
},
"TagResource": {
"name": "TagResource",
"http": {
"method": "POST",
"requestUri": "/tags/{resourceArn}",
"responseCode": 200
"UpdateConfig":{
"name":"UpdateConfig",
"http":{
"method":"PUT",
"requestUri":"/config/{configType}/{configId}",
"responseCode":200
},
"input": {
"shape": "TagResourceRequest"
},
"output": {
"shape": "TagResourceResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"UpdateConfigRequest"},
"output":{"shape":"ConfigIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Assigns a tag to a resource.</p>"
"documentation":"<p>Updates the <code>Config</code> used when scheduling contacts.</p> <p>Updating a <code>Config</code> will not update the execution parameters for existing future contacts scheduled with this <code>Config</code>.</p>",
"idempotent":true
},
"UntagResource": {
"name": "UntagResource",
"http": {
"method": "DELETE",
"requestUri": "/tags/{resourceArn}",
"responseCode": 200
"UpdateMissionProfile":{
"name":"UpdateMissionProfile",
"http":{
"method":"PUT",
"requestUri":"/missionprofile/{missionProfileId}",
"responseCode":200
},
"input": {
"shape": "UntagResourceRequest"
},
"output": {
"shape": "UntagResourceResponse"
},
"errors": [
{
"shape": "DependencyException"
},
{
"shape": "InvalidParameterException"
},
{
"shape": "ResourceNotFoundException"
}
"input":{"shape":"UpdateMissionProfileRequest"},
"output":{"shape":"MissionProfileIdResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"DependencyException"},
{"shape":"ResourceNotFoundException"}
],
"documentation": "<p>Deassigns a resource tag.</p>",
"idempotent": true
"documentation":"<p>Updates a mission profile.</p> <p>Updating a mission profile will not update the execution parameters for existing future contacts.</p>",
"idempotent":true
}
},
"shapes": {
"UpdateConfigRequest": {
"type": "structure",
"required": [
"configData",
"configId",
"configType",
"name"
],
"members": {
"configData": {
"shape": "ConfigTypeData",
"documentation": "<p>Parameters for a <code>Config</code>.</p>"
},
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configId"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configType"
},
"name": {
"shape": "SafeName",
"documentation": "<p>Name of a <code>Config</code>.</p>"
"shapes":{
"AngleUnits":{
"type":"string",
"enum":[
"DEGREE_ANGLE",
"RADIAN"
]
},
"AntennaDownlinkConfig":{
"type":"structure",
"required":["spectrumConfig"],
"members":{
"spectrumConfig":{
"shape":"SpectrumConfig",
"documentation":"<p>Object that describes a spectral <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p>Information about how AWS Ground Station should configure an antenna for downlink during a contact.</p>"
},
"ConfigTypeData": {
"type": "structure",
"members": {
"antennaDownlinkConfig": {
"shape": "AntennaDownlinkConfig",
"documentation": "<p>Information about how AWS Ground Station should configure an antenna for downlink during a contact.</p>"
},
"antennaDownlinkDemodDecodeConfig": {
"shape": "AntennaDownlinkDemodDecodeConfig",
"documentation": "<p>Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.</p>"
},
"antennaUplinkConfig": {
"shape": "AntennaUplinkConfig",
"documentation": "<p>Information about how AWS Ground Station should configure an antenna for uplink during a contact.</p>"
},
"dataflowEndpointConfig": {
"shape": "DataflowEndpointConfig",
"documentation": "<p>Information about the dataflow endpoint <code>Config</code>.</p>"
},
"trackingConfig": {
"shape": "TrackingConfig",
"documentation": "<p>Object that determines whether tracking should be used during a contact executed with this <code>Config</code> in the mission profile. </p>"
},
"uplinkEchoConfig": {
"shape": "UplinkEchoConfig",
"documentation": "<p>Information about an uplink echo <code>Config</code>.</p>\n <p>Parameters from the <code>AntennaUplinkConfig</code>, corresponding to the specified <code>AntennaUplinkConfigArn</code>, are used when this <code>UplinkEchoConfig</code> is used in a contact.</p>"
}
},
"documentation": "<p>Object containing the parameters for a <code>Config</code>.</p>\n <p>See the subtype definitions for what each type of <code>Config</code> contains.</p>"
},
"noradSatelliteID": {
"type": "integer",
"min": 1,
"max": 99999
},
"GroundStationData": {
"type": "structure",
"members": {
"groundStationId": {
"shape": "String",
"documentation": "<p>ID of a ground station.</p>"
},
"groundStationName": {
"shape": "String",
"documentation": "<p>Name of a ground station.</p>"
},
"region": {
"shape": "String",
"documentation": "<p>Ground station Region.</p>"
}
},
"documentation": "<p>Information about the ground station data.</p>"
},
"GetConfigRequest": {
"type": "structure",
"required": [
"configId",
"configType"
],
"members": {
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configId"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configType"
}
},
"documentation": "<p/>"
},
"GroundStationList": {
"type": "list",
"member": {
"shape": "GroundStationData"
}
},
"SecurityGroupIdList": {
"type": "list",
"member": {
"shape": "String"
}
},
"EndpointDetails": {
"type": "structure",
"members": {
"endpoint": {
"shape": "DataflowEndpoint",
"documentation": "<p>A dataflow endpoint.</p>"
},
"securityDetails": {
"shape": "SecurityDetails",
"documentation": "<p>Endpoint security details.</p>"
}
},
"documentation": "<p>Information about the endpoint details.</p>"
},
"DataflowEndpointGroupArn": {
"type": "string"
},
"GetMinuteUsageResponse": {
"type": "structure",
"members": {
"estimatedMinutesRemaining": {
"shape": "Integer",
"documentation": "<p>Estimated number of minutes remaining for an account, specific to the month being requested.</p>"
},
"isReservedMinutesCustomer": {
"shape": "Boolean",
"documentation": "<p>Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.</p>"
},
"totalReservedMinuteAllocation": {
"shape": "Integer",
"documentation": "<p>Total number of reserved minutes allocated, specific to the month being requested.</p>"
},
"totalScheduledMinutes": {
"shape": "Integer",
"documentation": "<p>Total scheduled minutes for an account, specific to the month being requested.</p>"
},
"upcomingMinutesScheduled": {
"shape": "Integer",
"documentation": "<p>Upcoming minutes scheduled for an account, specific to the month being requested.</p>"
}
},
"documentation": "<p/>"
},
"MissionProfileListItem": {
"type": "structure",
"members": {
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
},
"missionProfileId": {
"shape": "String",
"documentation": "<p>ID of a mission profile.</p>"
},
"name": {
"shape": "String",
"documentation": "<p>Name of a mission profile.</p>"
},
"region": {
"shape": "String",
"documentation": "<p>Region of a mission profile.</p>"
}
},
"documentation": "<p>Item in a list of mission profiles.</p>"
},
"SatelliteList": {
"type": "list",
"member": {
"shape": "SatelliteListItem"
}
},
"ListDataflowEndpointGroupsResponse": {
"type": "structure",
"members": {
"dataflowEndpointGroupList": {
"shape": "DataflowEndpointGroupList",
"documentation": "<p>A list of dataflow endpoint groups.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the response of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>"
}
},
"documentation": "<p/>"
},
"AntennaDownlinkDemodDecodeConfig": {
"type": "structure",
"required": [
"AntennaDownlinkDemodDecodeConfig":{
"type":"structure",
"required":[
"decodeConfig",
"demodulationConfig",
"spectrumConfig"
],
"members": {
"decodeConfig": {
"shape": "DecodeConfig",
"documentation": "<p>Information about the decode <code>Config</code>.</p>"
"members":{
"decodeConfig":{
"shape":"DecodeConfig",
"documentation":"<p>Information about the decode <code>Config</code>.</p>"
},
"demodulationConfig": {
"shape": "DemodulationConfig",
"documentation": "<p>Information about the demodulation <code>Config</code>.</p>"
"demodulationConfig":{
"shape":"DemodulationConfig",
"documentation":"<p>Information about the demodulation <code>Config</code>.</p>"
},
"spectrumConfig": {
"shape": "SpectrumConfig",
"documentation": "<p>Information about the spectral <code>Config</code>.</p>"
"spectrumConfig":{
"shape":"SpectrumConfig",
"documentation":"<p>Information about the spectral <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.</p>"
"documentation":"<p>Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.</p>"
},
"MissionProfileIdResponse": {
"type": "structure",
"members": {
"missionProfileId": {
"shape": "String",
"documentation": "<p>ID of a mission profile.</p>"
}
},
"documentation": "<p/>"
},
"SubnetList": {
"type": "list",
"member": {
"shape": "String"
}
},
"Polarization": {
"type": "string",
"enum": [
"LEFT_HAND",
"NONE",
"RIGHT_HAND"
]
},
"ConfigList": {
"type": "list",
"member": {
"shape": "ConfigListItem"
}
},
"AntennaUplinkConfig": {
"type": "structure",
"required": [
"AntennaUplinkConfig":{
"type":"structure",
"required":[
"spectrumConfig",
"targetEirp"
],
"members": {
"spectrumConfig": {
"shape": "UplinkSpectrumConfig",
"documentation": "<p>Information about the uplink spectral <code>Config</code>.</p>"
"members":{
"spectrumConfig":{
"shape":"UplinkSpectrumConfig",
"documentation":"<p>Information about the uplink spectral <code>Config</code>.</p>"
},
"targetEirp": {
"shape": "Eirp",
"documentation": "<p>EIRP of the target.</p>"
"targetEirp":{
"shape":"Eirp",
"documentation":"<p>EIRP of the target.</p>"
}
},
"documentation": "<p>Information about the uplink <code>Config</code> of an antenna.</p>"
"documentation":"<p>Information about the uplink <code>Config</code> of an antenna.</p>"
},
"Integer": {
"type": "integer",
"box": true
},
"AntennaDownlinkConfig": {
"type": "structure",
"required": [
"spectrumConfig"
],
"members": {
"spectrumConfig": {
"shape": "SpectrumConfig",
"documentation": "<p>Object that describes a spectral <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about how AWS Ground Station should configure an\n antenna for downlink during a contact.</p>"
},
"Boolean": {
"type": "boolean",
"box": true
},
"EndpointStatus": {
"type": "string",
"enum": [
"created",
"creating",
"deleted",
"deleting",
"failed"
"BandwidthUnits":{
"type":"string",
"enum":[
"GHz",
"MHz",
"kHz"
]
},
"UplinkEchoConfig": {
"type": "structure",
"required": [
"antennaUplinkConfigArn",
"enabled"
],
"members": {
"antennaUplinkConfigArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of an uplink <code>Config</code>.</p>"
"Boolean":{
"type":"boolean",
"box":true
},
"CancelContactRequest":{
"type":"structure",
"required":["contactId"],
"members":{
"contactId":{
"shape":"String",
"documentation":"<p>UUID of a contact.</p>",
"location":"uri",
"locationName":"contactId"
}
},
"documentation":"<p/>"
},
"ConfigArn":{"type":"string"},
"ConfigCapabilityType":{
"type":"string",
"enum":[
"antenna-downlink",
"antenna-downlink-demod-decode",
"antenna-uplink",
"dataflow-endpoint",
"tracking",
"uplink-echo"
]
},
"ConfigIdResponse":{
"type":"structure",
"members":{
"configArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a <code>Config</code>.</p>"
},
"enabled": {
"shape": "Boolean",
"documentation": "<p>Whether or not an uplink <code>Config</code> is enabled.</p>"
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about an uplink echo <code>Config</code>.</p>\n <p>Parameters from the <code>AntennaUplinkConfig</code>, corresponding to the \n specified <code>AntennaUplinkConfigArn</code>, are used when this <code>UplinkEchoConfig</code> \n is used in a contact.</p>"
"documentation":"<p/>"
},
"DecodeConfig": {
"type": "structure",
"required": [
"unvalidatedJSON"
],
"members": {
"unvalidatedJSON": {
"shape": "JsonString",
"documentation": "<p>Unvalidated JSON of a decode <code>Config</code>.</p>"
"ConfigList":{
"type":"list",
"member":{"shape":"ConfigListItem"}
},
"ConfigListItem":{
"type":"structure",
"members":{
"configArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a <code>Config</code>.</p>"
},
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>Name of a <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about the decode <code>Config</code>.</p>"
"documentation":"<p>An item in a list of <code>Config</code> objects.</p>"
},
"DeleteDataflowEndpointGroupRequest": {
"type": "structure",
"required": [
"dataflowEndpointGroupId"
],
"members": {
"dataflowEndpointGroupId": {
"shape": "String",
"documentation": "<p>ID of a dataflow endpoint group.</p>",
"location": "uri",
"locationName": "dataflowEndpointGroupId"
"ConfigTypeData":{
"type":"structure",
"members":{
"antennaDownlinkConfig":{
"shape":"AntennaDownlinkConfig",
"documentation":"<p>Information about how AWS Ground Station should configure an antenna for downlink during a contact.</p>"
},
"antennaDownlinkDemodDecodeConfig":{
"shape":"AntennaDownlinkDemodDecodeConfig",
"documentation":"<p>Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.</p>"
},
"antennaUplinkConfig":{
"shape":"AntennaUplinkConfig",
"documentation":"<p>Information about how AWS Ground Station should configure an antenna for uplink during a contact.</p>"
},
"dataflowEndpointConfig":{
"shape":"DataflowEndpointConfig",
"documentation":"<p>Information about the dataflow endpoint <code>Config</code>.</p>"
},
"trackingConfig":{
"shape":"TrackingConfig",
"documentation":"<p>Object that determines whether tracking should be used during a contact executed with this <code>Config</code> in the mission profile. </p>"
},
"uplinkEchoConfig":{
"shape":"UplinkEchoConfig",
"documentation":"<p>Information about an uplink echo <code>Config</code>.</p> <p>Parameters from the <code>AntennaUplinkConfig</code>, corresponding to the specified <code>AntennaUplinkConfigArn</code>, are used when this <code>UplinkEchoConfig</code> is used in a contact.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p>Object containing the parameters of a <code>Config</code>.</p> <p>See the subtype definitions for what each type of <code>Config</code> contains.</p>"
},
"ContactStatus": {
"type": "string",
"enum": [
"ContactData":{
"type":"structure",
"members":{
"contactId":{
"shape":"String",
"documentation":"<p>UUID of a contact.</p>"
},
"contactStatus":{
"shape":"ContactStatus",
"documentation":"<p>Status of a contact.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>End time of a contact.</p>"
},
"errorMessage":{
"shape":"String",
"documentation":"<p>Error message of a contact.</p>"
},
"groundStation":{
"shape":"String",
"documentation":"<p>Name of a ground station.</p>"
},
"maximumElevation":{
"shape":"Elevation",
"documentation":"<p>Maximum elevation angle of a contact.</p>"
},
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"postPassEndTime":{
"shape":"Timestamp",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"prePassStartTime":{
"shape":"Timestamp",
"documentation":"<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"region":{
"shape":"String",
"documentation":"<p>Region of a contact.</p>"
},
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>Start time of a contact.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a contact.</p>"
}
},
"documentation":"<p>Data describing a contact.</p>"
},
"ContactIdResponse":{
"type":"structure",
"members":{
"contactId":{
"shape":"String",
"documentation":"<p>UUID of a contact.</p>"
}
},
"documentation":"<p/>"
},
"ContactList":{
"type":"list",
"member":{"shape":"ContactData"}
},
"ContactStatus":{
"type":"string",
"enum":[
"AVAILABLE",
"AWS_CANCELLED",
"CANCELLED",
"CANCELLING",
"COMPLETED",
"FAILED",
"FAILED_TO_SCHEDULE",
@ -1040,1316 +681,1376 @@
"SCHEDULING"
]
},
"MissionProfileList": {
"type": "list",
"member": {
"shape": "MissionProfileListItem"
}
},
"CreateConfigRequest": {
"type": "structure",
"required": [
"CreateConfigRequest":{
"type":"structure",
"required":[
"configData",
"name"
],
"members": {
"configData": {
"shape": "ConfigTypeData",
"documentation": "<p>Parameters of a <code>Config</code>.</p>"
"members":{
"configData":{
"shape":"ConfigTypeData",
"documentation":"<p>Parameters of a <code>Config</code>.</p>"
},
"name": {
"shape": "SafeName",
"documentation": "<p>Name of a <code>Config</code>.</p>"
"name":{
"shape":"SafeName",
"documentation":"<p>Name of a <code>Config</code>.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a <code>Config</code>.</p>"
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"Frequency": {
"type": "structure",
"required": [
"units",
"value"
],
"members": {
"units": {
"shape": "FrequencyUnits",
"documentation": "<p>Frequency units.</p>"
"CreateDataflowEndpointGroupRequest":{
"type":"structure",
"required":["endpointDetails"],
"members":{
"endpointDetails":{
"shape":"EndpointDetailsList",
"documentation":"<p>Endpoint details of each endpoint in the dataflow endpoint group.</p>"
},
"value": {
"shape": "Double",
"documentation": "<p>Frequency value.</p>"
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags of a dataflow endpoint group.</p>"
}
},
"documentation": "<p>Object that describes the frequency.</p>"
"documentation":"<p/>"
},
"UntagResourceResponse": {
"type": "structure",
"members": { },
"documentation": "<p/>"
},
"ConfigIdResponse": {
"type": "structure",
"members": {
"configArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a <code>Config</code>.</p>"
},
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
},
"SecurityDetails": {
"type": "structure",
"required": [
"roleArn",
"securityGroupIds",
"subnetIds"
],
"members": {
"roleArn": {
"shape": "RoleArn",
"documentation": "<p>ARN to a role needed for connecting streams to your instances. </p>"
},
"securityGroupIds": {
"shape": "SecurityGroupIdList",
"documentation": "<p>The security groups to attach to the elastic network interfaces.</p>"
},
"subnetIds": {
"shape": "SubnetList",
"documentation": "<p>A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.</p>"
}
},
"documentation": "<p>Information about endpoints.</p>"
},
"TrackingConfig": {
"type": "structure",
"required": [
"autotrack"
],
"members": {
"autotrack": {
"shape": "Criticality",
"documentation": "<p>Current setting for autotrack.</p>"
}
},
"documentation": "<p>Object that determines whether tracking should be used during a contact\n executed with this <code>Config</code> in the mission profile.</p>"
},
"CreateDataflowEndpointGroupRequest": {
"type": "structure",
"required": [
"endpointDetails"
],
"members": {
"endpointDetails": {
"shape": "EndpointDetailsList",
"documentation": "<p>Endpoint details of each endpoint in the dataflow endpoint group.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags of a dataflow endpoint group.</p>"
}
},
"documentation": "<p/>"
},
"Elevation": {
"type": "structure",
"required": [
"unit",
"value"
],
"members": {
"unit": {
"shape": "AngleUnits",
"documentation": "<p>Elevation angle units.</p>"
},
"value": {
"shape": "Double",
"documentation": "<p>Elevation angle value.</p>"
}
},
"documentation": "<p>Elevation angle of the satellite in the sky during a contact.</p>"
},
"JsonString": {
"type": "string",
"min": 2,
"max": 8192
},
"GetSatelliteRequest": {
"type": "structure",
"required": [
"satelliteId"
],
"members": {
"satelliteId": {
"shape": "String",
"documentation": "<p>UUID of a satellite.</p>",
"location": "uri",
"locationName": "satelliteId"
}
},
"documentation": "<p/>"
},
"CancelContactRequest": {
"type": "structure",
"required": [
"contactId"
],
"members": {
"contactId": {
"shape": "String",
"documentation": "<p>UUID of a contact.</p>",
"location": "uri",
"locationName": "contactId"
}
},
"documentation": "<p/>"
},
"UplinkSpectrumConfig": {
"type": "structure",
"required": [
"centerFrequency"
],
"members": {
"centerFrequency": {
"shape": "Frequency",
"documentation": "<p>Center frequency of an uplink spectral <code>Config</code>.</p>"
},
"polarization": {
"shape": "Polarization",
"documentation": "<p>Polarization of an uplink spectral <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about the uplink spectral <code>Config</code>.</p>"
},
"UntagResourceRequest": {
"type": "structure",
"required": [
"resourceArn",
"tagKeys"
],
"members": {
"resourceArn": {
"shape": "String",
"documentation": "<p>ARN of a resource.</p>",
"location": "uri",
"locationName": "resourceArn"
},
"tagKeys": {
"shape": "TagKeys",
"documentation": "<p>Keys of a resource tag.</p>",
"location": "querystring",
"locationName": "tagKeys"
}
},
"documentation": "<p/>"
},
"satelliteArn": {
"type": "string"
},
"GetMissionProfileResponse": {
"type": "structure",
"members": {
"contactPostPassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"contactPrePassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"dataflowEdges": {
"shape": "DataflowEdgeList",
"documentation": "<p>A list of lists of ARNs. Each list of ARNs is an edge, with a from <code>Config</code> and a to \n <code>Config</code>.</p>"
},
"minimumViableContactDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
},
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
},
"missionProfileId": {
"shape": "String",
"documentation": "<p>ID of a mission profile.</p>"
},
"name": {
"shape": "String",
"documentation": "<p>Name of a mission profile.</p>"
},
"region": {
"shape": "String",
"documentation": "<p>Region of a mission profile.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a mission profile.</p>"
},
"trackingConfigArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a tracking <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
},
"ContactIdResponse": {
"type": "structure",
"members": {
"contactId": {
"shape": "String",
"documentation": "<p>UUID of a contact.</p>"
}
},
"documentation": "<p/>"
},
"EndpointDetailsList": {
"type": "list",
"member": {
"shape": "EndpointDetails"
}
},
"ListGroundStationsRequest": {
"type": "structure",
"members": {
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of ground stations returned.</p>",
"location": "querystring",
"locationName": "maxResults"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token that can be supplied in the next call to get the next page of ground stations.</p>",
"location": "querystring",
"locationName": "nextToken"
}
},
"documentation": "<p/>"
},
"InvalidParameterException": {
"type": "structure",
"members": {
"message": {
"shape": "String"
},
"parameterName": {
"shape": "String",
"documentation": "<p/>"
}
},
"documentation": "<p>One or more parameters are not valid.</p>",
"exception": true,
"error": {
"code": "InvalidParameterException",
"httpStatusCode": 431,
"senderFault": true
}
},
"DependencyException": {
"type": "structure",
"members": {
"message": {
"shape": "String"
},
"parameterName": {
"shape": "String",
"documentation": "<p/>"
}
},
"documentation": "<p>Dependency encountered an error.</p>",
"exception": true,
"error": {
"code": "DependencyException",
"httpStatusCode": 531,
"fault": true
}
},
"DescribeContactRequest": {
"type": "structure",
"required": [
"contactId"
],
"members": {
"contactId": {
"shape": "String",
"documentation": "<p>UUID of a contact.</p>",
"location": "uri",
"locationName": "contactId"
}
},
"documentation": "<p/>"
},
"ResourceNotFoundException": {
"type": "structure",
"members": {
"message": {
"shape": "String"
}
},
"documentation": "<p>Resource was not found.</p>",
"exception": true,
"error": {
"code": "ResourceNotFoundException",
"httpStatusCode": 434,
"senderFault": true
}
},
"Timestamp": {
"type": "timestamp"
},
"DeleteConfigRequest": {
"type": "structure",
"required": [
"configId",
"configType"
],
"members": {
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configId"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>",
"location": "uri",
"locationName": "configType"
}
},
"documentation": "<p/>"
},
"BandwidthUnits": {
"type": "string",
"enum": [
"GHz",
"MHz",
"kHz"
]
},
"SpectrumConfig": {
"type": "structure",
"required": [
"bandwidth",
"centerFrequency"
],
"members": {
"bandwidth": {
"shape": "FrequencyBandwidth",
"documentation": "<p>Bandwidth of a spectral <code>Config</code>.</p>"
},
"centerFrequency": {
"shape": "Frequency",
"documentation": "<p>Center frequency of a spectral <code>Config</code>.</p>"
},
"polarization": {
"shape": "Polarization",
"documentation": "<p>Polarization of a spectral <code>Config</code>.</p>"
}
},
"documentation": "<p>Object that describes a spectral <code>Config</code>.</p>"
},
"DemodulationConfig": {
"type": "structure",
"required": [
"unvalidatedJSON"
],
"members": {
"unvalidatedJSON": {
"shape": "JsonString",
"documentation": "<p>Unvalidated JSON of a demodulation <code>Config</code>.</p>"
}
},
"documentation": "<p>Information about the demodulation <code>Config</code>.</p>"
},
"ListMissionProfilesResponse": {
"type": "structure",
"members": {
"missionProfileList": {
"shape": "MissionProfileList",
"documentation": "<p>List of mission profiles</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the response of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>"
}
},
"documentation": "<p/>"
},
"ListConfigsResponse": {
"type": "structure",
"members": {
"configList": {
"shape": "ConfigList",
"documentation": "<p>List of <code>Config</code> items.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the response of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>"
}
},
"documentation": "<p/>"
},
"DataflowEdge": {
"type": "list",
"member": {
"shape": "ConfigArn"
},
"min": 2,
"max": 2
},
"SafeName": {
"type": "string",
"min": 1,
"max": 256,
"pattern": "^[ a-zA-Z0-9_:-]+$"
},
"Eirp": {
"type": "structure",
"required": [
"units",
"value"
],
"members": {
"units": {
"shape": "EirpUnits",
"documentation": "<p>Units of an EIRP.</p>"
},
"value": {
"shape": "Double",
"documentation": "<p>Value of an EIRP.</p>"
}
},
"documentation": "<p>Object that represents EIRP.</p>"
},
"RoleArn": {
"type": "string"
},
"ListMissionProfilesRequest": {
"type": "structure",
"members": {
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of mission profiles returned.</p>",
"location": "querystring",
"locationName": "maxResults"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the request of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken"
}
},
"documentation": "<p/>"
},
"GetSatelliteResponse": {
"type": "structure",
"members": {
"dateCreated": {
"shape": "Timestamp",
"documentation": "<p>When a satellite was created.</p>"
},
"lastUpdated": {
"shape": "Timestamp",
"documentation": "<p>When a satellite was last updated.</p>"
},
"noradSatelliteID": {
"shape": "noradSatelliteID",
"documentation": "<p>NORAD satellite ID number.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite.</p>"
},
"satelliteId": {
"shape": "Uuid",
"documentation": "<p>UUID of a satellite.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a satellite.</p>"
}
},
"documentation": "<p/>"
},
"StatusList": {
"type": "list",
"member": {
"shape": "ContactStatus"
}
},
"ListContactsRequest": {
"type": "structure",
"required": [
"endTime",
"startTime",
"statusList"
],
"members": {
"endTime": {
"shape": "Timestamp",
"documentation": "<p>End time of a contact.</p>"
},
"groundStation": {
"shape": "String",
"documentation": "<p>Name of a ground station.</p>"
},
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of contacts returned.</p>"
},
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the request of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite.</p>"
},
"startTime": {
"shape": "Timestamp",
"documentation": "<p>Start time of a contact.</p>"
},
"statusList": {
"shape": "StatusList",
"documentation": "<p>Status of a contact reservation.</p>"
}
},
"documentation": "<p/>"
},
"ContactData": {
"type": "structure",
"members": {
"contactId": {
"shape": "String",
"documentation": "<p>UUID of a contact.</p>"
},
"contactStatus": {
"shape": "ContactStatus",
"documentation": "<p>Status of a contact.</p>"
},
"endTime": {
"shape": "Timestamp",
"documentation": "<p>End time of a contact.</p>"
},
"errorMessage": {
"shape": "String",
"documentation": "<p>Error message of a contact.</p>"
},
"groundStation": {
"shape": "String",
"documentation": "<p>Name of a ground station.</p>"
},
"maximumElevation": {
"shape": "Elevation",
"documentation": "<p>Maximum elevation angle of a contact.</p>"
},
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
},
"postPassEndTime": {
"shape": "Timestamp",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"prePassStartTime": {
"shape": "Timestamp",
"documentation": "<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite.</p>"
},
"startTime": {
"shape": "Timestamp",
"documentation": "<p>Start time of a contact.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a contact.</p>"
}
},
"documentation": "<p>Data describing a contact.</p>"
},
"ListGroundStationsResponse": {
"type": "structure",
"members": {
"groundStationList": {
"shape": "GroundStationList",
"documentation": "<p>List of ground stations.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token that can be supplied in the next call to get the next page of ground stations.</p>"
}
},
"documentation": "<p/>"
},
"DataflowEndpoint": {
"type": "structure",
"members": {
"address": {
"shape": "SocketAddress",
"documentation": "<p>Socket address of a dataflow endpoint.</p>"
},
"name": {
"shape": "SafeName",
"documentation": "<p>Name of a dataflow endpoint.</p>"
},
"status": {
"shape": "EndpointStatus",
"documentation": "<p>Status of a dataflow endpoint.</p>"
}
},
"documentation": "<p>Information about a dataflow endpoint.</p>"
},
"ListConfigsRequest": {
"type": "structure",
"members": {
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of <code>Configs</code> returned.</p>",
"location": "querystring",
"locationName": "maxResults"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the request of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken"
}
},
"documentation": "<p/>"
},
"SocketAddress": {
"type": "structure",
"required": [
"name",
"port"
],
"members": {
"name": {
"shape": "String",
"documentation": "<p>Name of a socket address.</p>"
},
"port": {
"shape": "Integer",
"documentation": "<p>Port of a socket address.</p>"
}
},
"documentation": "<p>Information about the socket address.</p>"
},
"GetConfigResponse": {
"type": "structure",
"required": [
"configArn",
"configData",
"configId",
"name"
],
"members": {
"configArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a <code>Config</code>\n </p>"
},
"configData": {
"shape": "ConfigTypeData",
"documentation": "<p>Data elements in a <code>Config</code>.</p>"
},
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>"
},
"name": {
"shape": "String",
"documentation": "<p>Name of a <code>Config</code>.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
},
"TagsMap": {
"type": "map",
"key": {
"shape": "String"
},
"value": {
"shape": "String"
}
},
"TagResourceResponse": {
"type": "structure",
"members": { },
"documentation": "<p/>"
},
"DeleteMissionProfileRequest": {
"type": "structure",
"required": [
"missionProfileId"
],
"members": {
"missionProfileId": {
"shape": "String",
"documentation": "<p>UUID of a mission profile.</p>",
"location": "uri",
"locationName": "missionProfileId"
}
},
"documentation": "<p/>"
},
"DataflowEndpointGroupList": {
"type": "list",
"member": {
"shape": "DataflowEndpointListItem"
}
},
"ContactList": {
"type": "list",
"member": {
"shape": "ContactData"
}
},
"DurationInSeconds": {
"type": "integer",
"min": 1,
"max": 21600
},
"SatelliteListItem": {
"type": "structure",
"members": {
"noradSatelliteID": {
"shape": "noradSatelliteID",
"documentation": "<p>NORAD satellite ID number.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite.</p>"
},
"satelliteId": {
"shape": "Uuid",
"documentation": "<p>ID of a satellite.</p>"
}
},
"documentation": "<p>Item in a list of satellites.</p>"
},
"GetMissionProfileRequest": {
"type": "structure",
"required": [
"missionProfileId"
],
"members": {
"missionProfileId": {
"shape": "String",
"documentation": "<p>UUID of a mission profile.</p>",
"location": "uri",
"locationName": "missionProfileId"
}
},
"documentation": "<p/>"
},
"Double": {
"type": "double",
"box": true
},
"ListSatellitesResponse": {
"type": "structure",
"members": {
"nextToken": {
"shape": "String",
"documentation": "<p>Next token that can be supplied in the next call to get the next page of satellites.</p>"
},
"satellites": {
"shape": "SatelliteList",
"documentation": "<p>List of satellites.</p>"
}
},
"documentation": "<p/>"
},
"CreateMissionProfileRequest": {
"type": "structure",
"required": [
"CreateMissionProfileRequest":{
"type":"structure",
"required":[
"dataflowEdges",
"minimumViableContactDurationSeconds",
"name",
"trackingConfigArn"
],
"members": {
"contactPostPassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
"members":{
"contactPostPassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"contactPrePassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
"contactPrePassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"dataflowEdges": {
"shape": "DataflowEdgeList",
"documentation": "<p>A list of lists of ARNs. Each list of ARNs is an edge, with a from <code>Config</code> and a to \n <code>Config</code>.</p>"
"dataflowEdges":{
"shape":"DataflowEdgeList",
"documentation":"<p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i> <code>Config</code> and a <i>to</i> <code>Config</code>.</p>"
},
"minimumViableContactDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
"minimumViableContactDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
},
"name": {
"shape": "SafeName",
"documentation": "<p>Name of a mission profile.</p>"
"name":{
"shape":"SafeName",
"documentation":"<p>Name of a mission profile.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a mission profile.</p>"
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a mission profile.</p>"
},
"trackingConfigArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a tracking <code>Config</code>.</p>"
"trackingConfigArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a tracking <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"ReserveContactRequest": {
"type": "structure",
"required": [
"Criticality":{
"type":"string",
"enum":[
"PREFERRED",
"REMOVED",
"REQUIRED"
]
},
"DataflowEdge":{
"type":"list",
"member":{"shape":"ConfigArn"},
"max":2,
"min":2
},
"DataflowEdgeList":{
"type":"list",
"member":{"shape":"DataflowEdge"}
},
"DataflowEndpoint":{
"type":"structure",
"members":{
"address":{
"shape":"SocketAddress",
"documentation":"<p>Socket address of a dataflow endpoint.</p>"
},
"name":{
"shape":"SafeName",
"documentation":"<p>Name of a dataflow endpoint.</p>"
},
"status":{
"shape":"EndpointStatus",
"documentation":"<p>Status of a dataflow endpoint.</p>"
}
},
"documentation":"<p>Information about a dataflow endpoint.</p>"
},
"DataflowEndpointConfig":{
"type":"structure",
"required":["dataflowEndpointName"],
"members":{
"dataflowEndpointName":{
"shape":"String",
"documentation":"<p>Name of a dataflow endpoint.</p>"
},
"dataflowEndpointRegion":{
"shape":"String",
"documentation":"<p>Region of a dataflow endpoint.</p>"
}
},
"documentation":"<p>Information about the dataflow endpoint <code>Config</code>.</p>"
},
"DataflowEndpointGroupArn":{"type":"string"},
"DataflowEndpointGroupIdResponse":{
"type":"structure",
"members":{
"dataflowEndpointGroupId":{
"shape":"String",
"documentation":"<p>UUID of a dataflow endpoint group.</p>"
}
},
"documentation":"<p/>"
},
"DataflowEndpointGroupList":{
"type":"list",
"member":{"shape":"DataflowEndpointListItem"}
},
"DataflowEndpointListItem":{
"type":"structure",
"members":{
"dataflowEndpointGroupArn":{
"shape":"DataflowEndpointGroupArn",
"documentation":"<p>ARN of a dataflow endpoint group.</p>"
},
"dataflowEndpointGroupId":{
"shape":"String",
"documentation":"<p>UUID of a dataflow endpoint group.</p>"
}
},
"documentation":"<p>Item in a list of <code>DataflowEndpoint</code> groups.</p>"
},
"DecodeConfig":{
"type":"structure",
"required":["unvalidatedJSON"],
"members":{
"unvalidatedJSON":{
"shape":"JsonString",
"documentation":"<p>Unvalidated JSON of a decode <code>Config</code>.</p>"
}
},
"documentation":"<p>Information about the decode <code>Config</code>.</p>"
},
"DeleteConfigRequest":{
"type":"structure",
"required":[
"configId",
"configType"
],
"members":{
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configId"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configType"
}
},
"documentation":"<p/>"
},
"DeleteDataflowEndpointGroupRequest":{
"type":"structure",
"required":["dataflowEndpointGroupId"],
"members":{
"dataflowEndpointGroupId":{
"shape":"String",
"documentation":"<p>UUID of a dataflow endpoint group.</p>",
"location":"uri",
"locationName":"dataflowEndpointGroupId"
}
},
"documentation":"<p/>"
},
"DeleteMissionProfileRequest":{
"type":"structure",
"required":["missionProfileId"],
"members":{
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>",
"location":"uri",
"locationName":"missionProfileId"
}
},
"documentation":"<p/>"
},
"DemodulationConfig":{
"type":"structure",
"required":["unvalidatedJSON"],
"members":{
"unvalidatedJSON":{
"shape":"JsonString",
"documentation":"<p>Unvalidated JSON of a demodulation <code>Config</code>.</p>"
}
},
"documentation":"<p>Information about the demodulation <code>Config</code>.</p>"
},
"DependencyException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"parameterName":{
"shape":"String",
"documentation":"<p/>"
}
},
"documentation":"<p>Dependency encountered an error.</p>",
"error":{"httpStatusCode":531},
"exception":true,
"fault":true
},
"DescribeContactRequest":{
"type":"structure",
"required":["contactId"],
"members":{
"contactId":{
"shape":"String",
"documentation":"<p>UUID of a contact.</p>",
"location":"uri",
"locationName":"contactId"
}
},
"documentation":"<p/>"
},
"DescribeContactResponse":{
"type":"structure",
"members":{
"contactId":{
"shape":"String",
"documentation":"<p>UUID of a contact.</p>"
},
"contactStatus":{
"shape":"ContactStatus",
"documentation":"<p>Status of a contact.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>End time of a contact.</p>"
},
"errorMessage":{
"shape":"String",
"documentation":"<p>Error message for a contact.</p>"
},
"groundStation":{
"shape":"String",
"documentation":"<p>Ground station for a contact.</p>"
},
"maximumElevation":{
"shape":"Elevation",
"documentation":"<p>Maximum elevation angle of a contact.</p>"
},
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"postPassEndTime":{
"shape":"Timestamp",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"prePassStartTime":{
"shape":"Timestamp",
"documentation":"<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"region":{
"shape":"String",
"documentation":"<p>Region of a contact.</p>"
},
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>Start time of a contact.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a contact.</p>"
}
},
"documentation":"<p/>"
},
"Double":{
"type":"double",
"box":true
},
"DurationInSeconds":{
"type":"integer",
"max":21600,
"min":1
},
"Eirp":{
"type":"structure",
"required":[
"units",
"value"
],
"members":{
"units":{
"shape":"EirpUnits",
"documentation":"<p>Units of an EIRP.</p>"
},
"value":{
"shape":"Double",
"documentation":"<p>Value of an EIRP.</p>"
}
},
"documentation":"<p>Object that represents EIRP.</p>"
},
"EirpUnits":{
"type":"string",
"enum":["dBW"]
},
"Elevation":{
"type":"structure",
"required":[
"unit",
"value"
],
"members":{
"unit":{
"shape":"AngleUnits",
"documentation":"<p>Elevation angle units.</p>"
},
"value":{
"shape":"Double",
"documentation":"<p>Elevation angle value.</p>"
}
},
"documentation":"<p>Elevation angle of the satellite in the sky during a contact.</p>"
},
"EndpointDetails":{
"type":"structure",
"members":{
"endpoint":{
"shape":"DataflowEndpoint",
"documentation":"<p>A dataflow endpoint.</p>"
},
"securityDetails":{
"shape":"SecurityDetails",
"documentation":"<p>Endpoint security details.</p>"
}
},
"documentation":"<p>Information about the endpoint details.</p>"
},
"EndpointDetailsList":{
"type":"list",
"member":{"shape":"EndpointDetails"}
},
"EndpointStatus":{
"type":"string",
"enum":[
"created",
"creating",
"deleted",
"deleting",
"failed"
]
},
"Frequency":{
"type":"structure",
"required":[
"units",
"value"
],
"members":{
"units":{
"shape":"FrequencyUnits",
"documentation":"<p>Frequency units.</p>"
},
"value":{
"shape":"Double",
"documentation":"<p>Frequency value.</p>"
}
},
"documentation":"<p>Object that describes the frequency.</p>"
},
"FrequencyBandwidth":{
"type":"structure",
"required":[
"units",
"value"
],
"members":{
"units":{
"shape":"BandwidthUnits",
"documentation":"<p>Frequency bandwidth units.</p>"
},
"value":{
"shape":"Double",
"documentation":"<p>Frequency bandwidth value.</p>"
}
},
"documentation":"<p>Object that describes the frequency bandwidth.</p>"
},
"FrequencyUnits":{
"type":"string",
"enum":[
"GHz",
"MHz",
"kHz"
]
},
"GetConfigRequest":{
"type":"structure",
"required":[
"configId",
"configType"
],
"members":{
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configId"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configType"
}
},
"documentation":"<p/>"
},
"GetConfigResponse":{
"type":"structure",
"required":[
"configArn",
"configData",
"configId",
"name"
],
"members":{
"configArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a <code>Config</code> </p>"
},
"configData":{
"shape":"ConfigTypeData",
"documentation":"<p>Data elements in a <code>Config</code>.</p>"
},
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>Name of a <code>Config</code>.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a <code>Config</code>.</p>"
}
},
"documentation":"<p/>"
},
"GetDataflowEndpointGroupRequest":{
"type":"structure",
"required":["dataflowEndpointGroupId"],
"members":{
"dataflowEndpointGroupId":{
"shape":"String",
"documentation":"<p>UUID of a dataflow endpoint group.</p>",
"location":"uri",
"locationName":"dataflowEndpointGroupId"
}
},
"documentation":"<p/>"
},
"GetDataflowEndpointGroupResponse":{
"type":"structure",
"members":{
"dataflowEndpointGroupArn":{
"shape":"DataflowEndpointGroupArn",
"documentation":"<p>ARN of a dataflow endpoint group.</p>"
},
"dataflowEndpointGroupId":{
"shape":"String",
"documentation":"<p>UUID of a dataflow endpoint group.</p>"
},
"endpointsDetails":{
"shape":"EndpointDetailsList",
"documentation":"<p>Details of a dataflow endpoint.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a dataflow endpoint group.</p>"
}
},
"documentation":"<p/>"
},
"GetMinuteUsageRequest":{
"type":"structure",
"required":[
"month",
"year"
],
"members":{
"month":{
"shape":"Integer",
"documentation":"<p>The month being requested, with a value of 1-12.</p>"
},
"year":{
"shape":"Integer",
"documentation":"<p>The year being requested, in the format of YYYY.</p>"
}
},
"documentation":"<p/>"
},
"GetMinuteUsageResponse":{
"type":"structure",
"members":{
"estimatedMinutesRemaining":{
"shape":"Integer",
"documentation":"<p>Estimated number of minutes remaining for an account, specific to the month being requested.</p>"
},
"isReservedMinutesCustomer":{
"shape":"Boolean",
"documentation":"<p>Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.</p>"
},
"totalReservedMinuteAllocation":{
"shape":"Integer",
"documentation":"<p>Total number of reserved minutes allocated, specific to the month being requested.</p>"
},
"totalScheduledMinutes":{
"shape":"Integer",
"documentation":"<p>Total scheduled minutes for an account, specific to the month being requested.</p>"
},
"upcomingMinutesScheduled":{
"shape":"Integer",
"documentation":"<p>Upcoming minutes scheduled for an account, specific to the month being requested.</p>"
}
},
"documentation":"<p/>"
},
"GetMissionProfileRequest":{
"type":"structure",
"required":["missionProfileId"],
"members":{
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>",
"location":"uri",
"locationName":"missionProfileId"
}
},
"documentation":"<p/>"
},
"GetMissionProfileResponse":{
"type":"structure",
"members":{
"contactPostPassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"contactPrePassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"dataflowEdges":{
"shape":"DataflowEdgeList",
"documentation":"<p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i> <code>Config</code> and a <i>to</i> <code>Config</code>.</p>"
},
"minimumViableContactDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
},
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>Name of a mission profile.</p>"
},
"region":{
"shape":"String",
"documentation":"<p>Region of a mission profile.</p>"
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a mission profile.</p>"
},
"trackingConfigArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a tracking <code>Config</code>.</p>"
}
},
"documentation":"<p/>"
},
"GetSatelliteRequest":{
"type":"structure",
"required":["satelliteId"],
"members":{
"satelliteId":{
"shape":"String",
"documentation":"<p>UUID of a satellite.</p>",
"location":"uri",
"locationName":"satelliteId"
}
},
"documentation":"<p/>"
},
"GetSatelliteResponse":{
"type":"structure",
"members":{
"groundStations":{
"shape":"GroundStationIdList",
"documentation":"<p>A list of ground stations to which the satellite is on-boarded.</p>"
},
"noradSatelliteID":{
"shape":"noradSatelliteID",
"documentation":"<p>NORAD satellite ID number.</p>"
},
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite.</p>"
},
"satelliteId":{
"shape":"Uuid",
"documentation":"<p>UUID of a satellite.</p>"
}
},
"documentation":"<p/>"
},
"GroundStationData":{
"type":"structure",
"members":{
"groundStationId":{
"shape":"String",
"documentation":"<p>UUID of a ground station.</p>"
},
"groundStationName":{
"shape":"String",
"documentation":"<p>Name of a ground station.</p>"
},
"region":{
"shape":"String",
"documentation":"<p>Ground station Region.</p>"
}
},
"documentation":"<p>Information about the ground station data.</p>"
},
"GroundStationIdList":{
"type":"list",
"member":{"shape":"String"}
},
"GroundStationList":{
"type":"list",
"member":{"shape":"GroundStationData"}
},
"Integer":{
"type":"integer",
"box":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"parameterName":{
"shape":"String",
"documentation":"<p/>"
}
},
"documentation":"<p>One or more parameters are not valid.</p>",
"error":{
"httpStatusCode":431,
"senderFault":true
},
"exception":true
},
"JsonString":{
"type":"string",
"max":8192,
"min":2,
"pattern":"^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$"
},
"ListConfigsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of <code>Configs</code> returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the request of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p/>"
},
"ListConfigsResponse":{
"type":"structure",
"members":{
"configList":{
"shape":"ConfigList",
"documentation":"<p>List of <code>Config</code> items.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the response of a previous <code>ListConfigs</code> call. Used to get the next page of results.</p>"
}
},
"documentation":"<p/>"
},
"ListContactsRequest":{
"type":"structure",
"required":[
"endTime",
"startTime",
"statusList"
],
"members":{
"endTime":{
"shape":"Timestamp",
"documentation":"<p>End time of a contact.</p>"
},
"groundStation":{
"shape":"String",
"documentation":"<p>Name of a ground station.</p>"
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of contacts returned.</p>"
},
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the request of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>"
},
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>Start time of a contact.</p>"
},
"statusList":{
"shape":"StatusList",
"documentation":"<p>Status of a contact reservation.</p>"
}
},
"documentation":"<p/>"
},
"ListContactsResponse":{
"type":"structure",
"members":{
"contactList":{
"shape":"ContactList",
"documentation":"<p>List of contacts.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the response of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>"
}
},
"documentation":"<p/>"
},
"ListDataflowEndpointGroupsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of dataflow endpoint groups returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the request of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p/>"
},
"ListDataflowEndpointGroupsResponse":{
"type":"structure",
"members":{
"dataflowEndpointGroupList":{
"shape":"DataflowEndpointGroupList",
"documentation":"<p>A list of dataflow endpoint groups.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the response of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>"
}
},
"documentation":"<p/>"
},
"ListGroundStationsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of ground stations returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token that can be supplied in the next call to get the next page of ground stations.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"satelliteId":{
"shape":"String",
"documentation":"<p>Satellite ID to retrieve on-boarded ground stations.</p>",
"location":"querystring",
"locationName":"satelliteId"
}
},
"documentation":"<p/>"
},
"ListGroundStationsResponse":{
"type":"structure",
"members":{
"groundStationList":{
"shape":"GroundStationList",
"documentation":"<p>List of ground stations.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token that can be supplied in the next call to get the next page of ground stations.</p>"
}
},
"documentation":"<p/>"
},
"ListMissionProfilesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of mission profiles returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the request of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p/>"
},
"ListMissionProfilesResponse":{
"type":"structure",
"members":{
"missionProfileList":{
"shape":"MissionProfileList",
"documentation":"<p>List of mission profiles.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token returned in the response of a previous <code>ListMissionProfiles</code> call. Used to get the next page of results.</p>"
}
},
"documentation":"<p/>"
},
"ListSatellitesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"Integer",
"documentation":"<p>Maximum number of satellites returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Next token that can be supplied in the next call to get the next page of satellites.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p/>"
},
"ListSatellitesResponse":{
"type":"structure",
"members":{
"nextToken":{
"shape":"String",
"documentation":"<p>Next token that can be supplied in the next call to get the next page of satellites.</p>"
},
"satellites":{
"shape":"SatelliteList",
"documentation":"<p>List of satellites.</p>"
}
},
"documentation":"<p/>"
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>ARN of a resource.</p>",
"location":"uri",
"locationName":"resourceArn"
}
},
"documentation":"<p/>"
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a resource.</p>"
}
},
"documentation":"<p/>"
},
"MissionProfileArn":{"type":"string"},
"MissionProfileIdResponse":{
"type":"structure",
"members":{
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>"
}
},
"documentation":"<p/>"
},
"MissionProfileList":{
"type":"list",
"member":{"shape":"MissionProfileListItem"}
},
"MissionProfileListItem":{
"type":"structure",
"members":{
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>Name of a mission profile.</p>"
},
"region":{
"shape":"String",
"documentation":"<p>Region of a mission profile.</p>"
}
},
"documentation":"<p>Item in a list of mission profiles.</p>"
},
"Polarization":{
"type":"string",
"enum":[
"LEFT_HAND",
"NONE",
"RIGHT_HAND"
]
},
"ReserveContactRequest":{
"type":"structure",
"required":[
"endTime",
"groundStation",
"missionProfileArn",
"satelliteArn",
"startTime"
],
"members": {
"endTime": {
"shape": "Timestamp",
"documentation": "<p>End time of a contact.</p>"
"members":{
"endTime":{
"shape":"Timestamp",
"documentation":"<p>End time of a contact.</p>"
},
"groundStation": {
"shape": "String",
"documentation": "<p>Name of a ground station.</p>"
"groundStation":{
"shape":"String",
"documentation":"<p>Name of a ground station.</p>"
},
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
"missionProfileArn":{
"shape":"MissionProfileArn",
"documentation":"<p>ARN of a mission profile.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite</p>"
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite</p>"
},
"startTime": {
"shape": "Timestamp",
"documentation": "<p>Start time of a contact.</p>"
"startTime":{
"shape":"Timestamp",
"documentation":"<p>Start time of a contact.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a contact.</p>"
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a contact.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"DataflowEndpointConfig": {
"type": "structure",
"required": [
"dataflowEndpointName"
"ResourceLimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"},
"parameterName":{
"shape":"String",
"documentation":"<p/>"
}
},
"documentation":"<p>Account limits for this resource have been exceeded.</p>",
"error":{
"httpStatusCode":429,
"senderFault":true
},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>Resource was not found.</p>",
"error":{
"httpStatusCode":434,
"senderFault":true
},
"exception":true
},
"RoleArn":{"type":"string"},
"SafeName":{
"type":"string",
"max":256,
"min":1,
"pattern":"^[ a-zA-Z0-9_:-]{1,256}$"
},
"SatelliteList":{
"type":"list",
"member":{"shape":"SatelliteListItem"}
},
"SatelliteListItem":{
"type":"structure",
"members":{
"groundStations":{
"shape":"GroundStationIdList",
"documentation":"<p>A list of ground stations to which the satellite is on-boarded.</p>"
},
"noradSatelliteID":{
"shape":"noradSatelliteID",
"documentation":"<p>NORAD satellite ID number.</p>"
},
"satelliteArn":{
"shape":"satelliteArn",
"documentation":"<p>ARN of a satellite.</p>"
},
"satelliteId":{
"shape":"Uuid",
"documentation":"<p>UUID of a satellite.</p>"
}
},
"documentation":"<p>Item in a list of satellites.</p>"
},
"SecurityDetails":{
"type":"structure",
"required":[
"roleArn",
"securityGroupIds",
"subnetIds"
],
"members": {
"dataflowEndpointName": {
"shape": "String",
"documentation": "<p>Name of a dataflow endpoint.</p>"
"members":{
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>ARN to a role needed for connecting streams to your instances. </p>"
},
"securityGroupIds":{
"shape":"SecurityGroupIdList",
"documentation":"<p>The security groups to attach to the elastic network interfaces.</p>"
},
"subnetIds":{
"shape":"SubnetList",
"documentation":"<p>A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.</p>"
}
},
"documentation": "<p>Information about the dataflow endpoint <code>Config</code>.</p>"
"documentation":"<p>Information about endpoints.</p>"
},
"Uuid": {
"type": "string",
"min": 1,
"max": 128,
"pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
"SecurityGroupIdList":{
"type":"list",
"member":{"shape":"String"}
},
"ListTagsForResourceResponse": {
"type": "structure",
"members": {
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a resource.</p>"
}
},
"documentation": "<p/>"
},
"MissionProfileArn": {
"type": "string"
},
"ListContactsResponse": {
"type": "structure",
"members": {
"contactList": {
"shape": "ContactList",
"documentation": "<p>List of contacts.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the response of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>"
}
},
"documentation": "<p/>"
},
"DataflowEdgeList": {
"type": "list",
"member": {
"shape": "DataflowEdge"
}
},
"DescribeContactResponse": {
"type": "structure",
"members": {
"contactId": {
"shape": "String",
"documentation": "<p>UUID of a contact.</p>"
},
"contactStatus": {
"shape": "ContactStatus",
"documentation": "<p>Status of a contact.</p>"
},
"endTime": {
"shape": "Timestamp",
"documentation": "<p>End time of a contact.</p>"
},
"errorMessage": {
"shape": "String",
"documentation": "<p>Error message for a contact.</p>"
},
"groundStation": {
"shape": "String",
"documentation": "<p>Ground station for a contact.</p>"
},
"maximumElevation": {
"shape": "Elevation",
"documentation": "<p>Maximum elevation angle of a contact.</p>"
},
"missionProfileArn": {
"shape": "MissionProfileArn",
"documentation": "<p>ARN of a mission profile.</p>"
},
"postPassEndTime": {
"shape": "Timestamp",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"prePassStartTime": {
"shape": "Timestamp",
"documentation": "<p>Amount of time prior to contact start youd like to receive a CloudWatch event indicating an upcoming pass.</p>"
},
"satelliteArn": {
"shape": "satelliteArn",
"documentation": "<p>ARN of a satellite.</p>"
},
"startTime": {
"shape": "Timestamp",
"documentation": "<p>Start time of a contact.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a contact.</p>"
}
},
"documentation": "<p/>"
},
"ConfigListItem": {
"type": "structure",
"members": {
"configArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a <code>Config</code>.</p>"
},
"configId": {
"shape": "String",
"documentation": "<p>UUID of a <code>Config</code>.</p>"
},
"configType": {
"shape": "ConfigCapabilityType",
"documentation": "<p>Type of a <code>Config</code>.</p>"
},
"name": {
"shape": "String",
"documentation": "<p>Name of a <code>Config</code>.</p>"
}
},
"documentation": "<p>An item in a list of <code>Config</code> objects.</p>"
},
"ListTagsForResourceRequest": {
"type": "structure",
"required": [
"resourceArn"
"SocketAddress":{
"type":"structure",
"required":[
"name",
"port"
],
"members": {
"resourceArn": {
"shape": "String",
"documentation": "<p>ARN of a resource.</p>",
"location": "uri",
"locationName": "resourceArn"
}
},
"documentation": "<p/>"
},
"ListDataflowEndpointGroupsRequest": {
"type": "structure",
"members": {
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of dataflow endpoint groups returned.</p>",
"location": "querystring",
"locationName": "maxResults"
"members":{
"name":{
"shape":"String",
"documentation":"<p>Name of a socket address.</p>"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token returned in the request of a previous <code>ListDataflowEndpointGroups</code> call. Used to get the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken"
"port":{
"shape":"Integer",
"documentation":"<p>Port of a socket address.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p>Information about the socket address.</p>"
},
"FrequencyBandwidth": {
"type": "structure",
"required": [
"units",
"value"
"SpectrumConfig":{
"type":"structure",
"required":[
"bandwidth",
"centerFrequency"
],
"members": {
"units": {
"shape": "BandwidthUnits",
"documentation": "<p>Frequency bandwidth units.</p>"
"members":{
"bandwidth":{
"shape":"FrequencyBandwidth",
"documentation":"<p>Bandwidth of a spectral <code>Config</code>.</p>"
},
"value": {
"shape": "Double",
"documentation": "<p>Frequency bandwidth value.</p>"
"centerFrequency":{
"shape":"Frequency",
"documentation":"<p>Center frequency of a spectral <code>Config</code>.</p>"
},
"polarization":{
"shape":"Polarization",
"documentation":"<p>Polarization of a spectral <code>Config</code>.</p>"
}
},
"documentation": "<p>Object that describes the frequency bandwidth.</p>"
"documentation":"<p>Object that describes a spectral <code>Config</code>.</p>"
},
"String": {
"type": "string"
"StatusList":{
"type":"list",
"member":{"shape":"ContactStatus"}
},
"ListSatellitesRequest": {
"type": "structure",
"members": {
"maxResults": {
"shape": "Integer",
"documentation": "<p>Maximum number of satellites returned.</p>",
"location": "querystring",
"locationName": "maxResults"
},
"nextToken": {
"shape": "String",
"documentation": "<p>Next token that can be supplied in the next call to get the next page of satellites.</p>",
"location": "querystring",
"locationName": "nextToken"
}
},
"documentation": "<p/>"
"String":{"type":"string"},
"SubnetList":{
"type":"list",
"member":{"shape":"String"}
},
"UpdateMissionProfileRequest": {
"type": "structure",
"required": [
"missionProfileId"
"TagKeys":{
"type":"list",
"member":{"shape":"String"}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members": {
"contactPostPassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>ARN of a resource tag.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"contactPrePassDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"dataflowEdges": {
"shape": "DataflowEdgeList",
"documentation": "<p>A list of lists of ARNs. Each list of ARNs is an edge, with a from <code>Config</code> and a to \n <code>Config</code>.</p>"
},
"minimumViableContactDurationSeconds": {
"shape": "DurationInSeconds",
"documentation": "<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
},
"missionProfileId": {
"shape": "String",
"documentation": "<p>ID of a mission profile.</p>",
"location": "uri",
"locationName": "missionProfileId"
},
"name": {
"shape": "SafeName",
"documentation": "<p>Name of a mission profile.</p>"
},
"trackingConfigArn": {
"shape": "ConfigArn",
"documentation": "<p>ARN of a tracking <code>Config</code>.</p>"
"tags":{
"shape":"TagsMap",
"documentation":"<p>Tags assigned to a resource.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"FrequencyUnits": {
"type": "string",
"enum": [
"GHz",
"MHz",
"kHz"
]
"TagResourceResponse":{
"type":"structure",
"members":{
},
"documentation":"<p/>"
},
"TagResourceRequest": {
"type": "structure",
"required": [
"resourceArn"
"TagsMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"Timestamp":{"type":"timestamp"},
"TrackingConfig":{
"type":"structure",
"required":["autotrack"],
"members":{
"autotrack":{
"shape":"Criticality",
"documentation":"<p>Current setting for autotrack.</p>"
}
},
"documentation":"<p>Object that determines whether tracking should be used during a contact executed with this <code>Config</code> in the mission profile.</p>"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members": {
"resourceArn": {
"shape": "String",
"documentation": "<p>ARN of a resource tag.</p>",
"location": "uri",
"locationName": "resourceArn"
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>ARN of a resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a resource.</p>"
"tagKeys":{
"shape":"TagKeys",
"documentation":"<p>Keys of a resource tag.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"Criticality": {
"type": "string",
"enum": [
"PREFERRED",
"REMOVED",
"REQUIRED"
]
},
"ConfigCapabilityType": {
"type": "string",
"enum": [
"antenna-downlink",
"antenna-downlink-demod-decode",
"antenna-uplink",
"dataflow-endpoint",
"tracking",
"uplink-echo"
]
},
"TagKeys": {
"type": "list",
"member": {
"shape": "String"
}
},
"AngleUnits": {
"type": "string",
"enum": [
"DEGREE_ANGLE",
"RADIAN"
]
},
"DataflowEndpointListItem": {
"type": "structure",
"members": {
"dataflowEndpointGroupArn": {
"shape": "DataflowEndpointGroupArn",
"documentation": "<p>ARN of a dataflow endpoint group.</p>"
},
"dataflowEndpointGroupId": {
"shape": "String",
"documentation": "<p>UUID of a dataflow endpoint group.</p>"
}
"UntagResourceResponse":{
"type":"structure",
"members":{
},
"documentation": "<p>Item in a list of <code>DataflowEndpoint</code> groups.</p>"
"documentation":"<p/>"
},
"GetDataflowEndpointGroupResponse": {
"type": "structure",
"members": {
"dataflowEndpointGroupArn": {
"shape": "DataflowEndpointGroupArn",
"documentation": "<p>ARN of a dataflow endpoint group.</p>"
},
"dataflowEndpointGroupId": {
"shape": "String",
"documentation": "<p>UUID of a dataflow endpoint group.</p>"
},
"endpointsDetails": {
"shape": "EndpointDetailsList",
"documentation": "<p>Details of a dataflow endpoint.</p>"
},
"tags": {
"shape": "TagsMap",
"documentation": "<p>Tags assigned to a dataflow endpoint group.</p>"
}
},
"documentation": "<p/>"
},
"GetDataflowEndpointGroupRequest": {
"type": "structure",
"required": [
"dataflowEndpointGroupId"
"UpdateConfigRequest":{
"type":"structure",
"required":[
"configData",
"configId",
"configType",
"name"
],
"members": {
"dataflowEndpointGroupId": {
"shape": "String",
"documentation": "<p>UUID of a dataflow endpoint group.</p>",
"location": "uri",
"locationName": "dataflowEndpointGroupId"
}
},
"documentation": "<p/>"
},
"ConfigArn": {
"type": "string"
},
"GetMinuteUsageRequest": {
"type": "structure",
"required": [
"month",
"year"
],
"members": {
"month": {
"shape": "Integer",
"documentation": "<p>The month being requested, with a value of 1-12.</p>"
"members":{
"configData":{
"shape":"ConfigTypeData",
"documentation":"<p>Parameters of a <code>Config</code>.</p>"
},
"year": {
"shape": "Integer",
"documentation": "<p>The year being requested, in the format of YYYY.</p>"
"configId":{
"shape":"String",
"documentation":"<p>UUID of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configId"
},
"configType":{
"shape":"ConfigCapabilityType",
"documentation":"<p>Type of a <code>Config</code>.</p>",
"location":"uri",
"locationName":"configType"
},
"name":{
"shape":"SafeName",
"documentation":"<p>Name of a <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"DataflowEndpointGroupIdResponse": {
"type": "structure",
"members": {
"dataflowEndpointGroupId": {
"shape": "String",
"documentation": "<p>ID of a dataflow endpoint group.</p>"
"UpdateMissionProfileRequest":{
"type":"structure",
"required":["missionProfileId"],
"members":{
"contactPostPassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"contactPrePassDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Amount of time after a contact ends that youd like to receive a CloudWatch event indicating the pass has finished.</p>"
},
"dataflowEdges":{
"shape":"DataflowEdgeList",
"documentation":"<p>A list of lists of ARNs. Each list of ARNs is an edge, with a <i>from</i> <code>Config</code> and a <i>to</i> <code>Config</code>.</p>"
},
"minimumViableContactDurationSeconds":{
"shape":"DurationInSeconds",
"documentation":"<p>Smallest amount of time in seconds that youd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.</p>"
},
"missionProfileId":{
"shape":"String",
"documentation":"<p>UUID of a mission profile.</p>",
"location":"uri",
"locationName":"missionProfileId"
},
"name":{
"shape":"SafeName",
"documentation":"<p>Name of a mission profile.</p>"
},
"trackingConfigArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of a tracking <code>Config</code>.</p>"
}
},
"documentation": "<p/>"
"documentation":"<p/>"
},
"EirpUnits": {
"type": "string",
"enum": [
"dBW"
]
}
}
"UplinkEchoConfig":{
"type":"structure",
"required":[
"antennaUplinkConfigArn",
"enabled"
],
"members":{
"antennaUplinkConfigArn":{
"shape":"ConfigArn",
"documentation":"<p>ARN of an uplink <code>Config</code>.</p>"
},
"enabled":{
"shape":"Boolean",
"documentation":"<p>Whether or not an uplink <code>Config</code> is enabled.</p>"
}
},
"documentation":"<p>Information about an uplink echo <code>Config</code>.</p> <p>Parameters from the <code>AntennaUplinkConfig</code>, corresponding to the specified <code>AntennaUplinkConfigArn</code>, are used when this <code>UplinkEchoConfig</code> is used in a contact.</p>"
},
"UplinkSpectrumConfig":{
"type":"structure",
"required":["centerFrequency"],
"members":{
"centerFrequency":{
"shape":"Frequency",
"documentation":"<p>Center frequency of an uplink spectral <code>Config</code>.</p>"
},
"polarization":{
"shape":"Polarization",
"documentation":"<p>Polarization of an uplink spectral <code>Config</code>.</p>"
}
},
"documentation":"<p>Information about the uplink spectral <code>Config</code>.</p>"
},
"Uuid":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
},
"noradSatelliteID":{
"type":"integer",
"max":99999,
"min":1
},
"satelliteArn":{"type":"string"}
},
"documentation":"<p>Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.</p>"
}

View file

@ -23,6 +23,27 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "eventTypes"
},
"DescribeAffectedAccountsForOrganization": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "affectedAccounts"
},
"DescribeAffectedEntitiesForOrganization": {
"input_token": "nextToken",
"limit_key": "maxResults",
"non_aggregate_keys": [
"failedSet"
],
"output_token": "nextToken",
"result_key": "entities"
},
"DescribeEventsForOrganization": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "events"
}
}
}

View file

@ -13,6 +13,20 @@
"uid":"health-2016-08-04"
},
"operations":{
"DescribeAffectedAccountsForOrganization":{
"name":"DescribeAffectedAccountsForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAffectedAccountsForOrganizationRequest"},
"output":{"shape":"DescribeAffectedAccountsForOrganizationResponse"},
"errors":[
{"shape":"InvalidPaginationToken"}
],
"documentation":"<p>Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account.</p>",
"idempotent":true
},
"DescribeAffectedEntities":{
"name":"DescribeAffectedEntities",
"http":{
@ -28,6 +42,21 @@
"documentation":"<p>Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.</p> <p>At least one event ARN is required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>",
"idempotent":true
},
"DescribeAffectedEntitiesForOrganization":{
"name":"DescribeAffectedEntitiesForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAffectedEntitiesForOrganizationRequest"},
"output":{"shape":"DescribeAffectedEntitiesForOrganizationResponse"},
"errors":[
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.</p> <p>At least one event ARN and account ID are required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </p>",
"idempotent":true
},
"DescribeEntityAggregates":{
"name":"DescribeEntityAggregates",
"http":{
@ -64,7 +93,21 @@
"errors":[
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by <a>DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the <a>DescribeAffectedEntities</a> operation.</p> <p>If a specified event cannot be retrieved, an error message is returned for that event.</p>",
"documentation":"<p>Returns detailed information about one or more specified events. Information includes standard event data (region, service, and so on, as returned by <a>DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the <a>DescribeAffectedEntities</a> operation.</p> <p>If a specified event cannot be retrieved, an error message is returned for that event.</p>",
"idempotent":true
},
"DescribeEventDetailsForOrganization":{
"name":"DescribeEventDetailsForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventDetailsForOrganizationRequest"},
"output":{"shape":"DescribeEventDetailsForOrganizationResponse"},
"errors":[
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by <a>DescribeEventsForOrganization</a>, a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the <a>DescribeAffectedEntitiesForOrganization</a> operation.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account.</p>",
"idempotent":true
},
"DescribeEventTypes":{
@ -96,6 +139,55 @@
],
"documentation":"<p>Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the <a>DescribeEventDetails</a> and <a>DescribeAffectedEntities</a> operations.</p> <p>If no filter criteria are specified, all events are returned. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent.</p>",
"idempotent":true
},
"DescribeEventsForOrganization":{
"name":"DescribeEventsForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventsForOrganizationRequest"},
"output":{"shape":"DescribeEventsForOrganizationResponse"},
"errors":[
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the <a>DescribeAffectedAccountsForOrganization</a>, <a>DescribeEventDetailsForOrganization</a>, and <a>DescribeAffectedEntitiesForOrganization</a> operations.</p> <p>If no filter criteria are specified, all events across your organization are returned. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent.</p> <p>Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the <a>EnableHealthServiceAccessForOrganization</a> operation from your organization's master account.</p>",
"idempotent":true
},
"DescribeHealthServiceStatusForOrganization":{
"name":"DescribeHealthServiceStatusForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{"shape":"DescribeHealthServiceStatusForOrganizationResponse"},
"documentation":"<p>This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.</p>",
"idempotent":true
},
"DisableHealthServiceAccessForOrganization":{
"name":"DisableHealthServiceAccessForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"errors":[
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Calling this operation disables Health from working with AWS Organizations. This does not remove the Service Linked Role (SLR) from the the master account in your organization. Use the IAM console, API, or AWS CLI to remove the SLR if desired. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.</p>",
"idempotent":true
},
"EnableHealthServiceAccessForOrganization":{
"name":"EnableHealthServiceAccessForOrganization",
"http":{
"method":"POST",
"requestUri":"/"
},
"errors":[
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Calling this operation enables AWS Health to work with AWS Organizations. This applies a Service Linked Role (SLR) to the master account in the organization. To learn more about the steps in this process, visit enabling service access for AWS Health in AWS Organizations. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.</p>",
"idempotent":true
}
},
"shapes":{
@ -114,7 +206,10 @@
"shape":"entityValue",
"documentation":"<p>The ID of the affected entity.</p>"
},
"entityUrl":{"shape":"entityUrl"},
"entityUrl":{
"shape":"entityUrl",
"documentation":"<p>The URL of the affected entity.</p>"
},
"awsAccountId":{
"shape":"accountId",
"documentation":"<p>The 12-digit AWS account number that contains the affected entity.</p>"
@ -134,6 +229,14 @@
},
"documentation":"<p>Information about an entity that is affected by a Health event.</p>"
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{"shape":"string"}
},
"documentation":"<p> <a>EnableHealthServiceAccessForOrganization</a> is already in progress. Wait for the action to complete before trying again. To get the current status, use the <a>DescribeHealthServiceStatusForOrganization</a> operation.</p>",
"exception":true
},
"DateTimeRange":{
"type":"structure",
"members":{
@ -148,13 +251,87 @@
},
"documentation":"<p>A range of dates and times that is used by the <a>EventFilter</a> and <a>EntityFilter</a> objects. If <code>from</code> is set and <code>to</code> is set: match items where the timestamp (<code>startTime</code>, <code>endTime</code>, or <code>lastUpdatedTime</code>) is between <code>from</code> and <code>to</code> inclusive. If <code>from</code> is set and <code>to</code> is not set: match items where the timestamp value is equal to or after <code>from</code>. If <code>from</code> is not set and <code>to</code> is set: match items where the timestamp value is equal to or before <code>to</code>.</p>"
},
"DescribeAffectedAccountsForOrganizationRequest":{
"type":"structure",
"required":["eventArn"],
"members":{
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
},
"maxResults":{
"shape":"maxResults",
"documentation":"<p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>"
}
}
},
"DescribeAffectedAccountsForOrganizationResponse":{
"type":"structure",
"members":{
"affectedAccounts":{
"shape":"affectedAccountsList",
"documentation":"<p>A JSON set of elements of the affected accounts.</p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
}
}
},
"DescribeAffectedEntitiesForOrganizationFailedSet":{
"type":"list",
"member":{"shape":"OrganizationAffectedEntitiesErrorItem"}
},
"DescribeAffectedEntitiesForOrganizationRequest":{
"type":"structure",
"required":["organizationEntityFilters"],
"members":{
"organizationEntityFilters":{
"shape":"OrganizationEntityFiltersList",
"documentation":"<p>A JSON set of elements including the <code>awsAccountId</code> and the <code>eventArn</code>.</p>"
},
"locale":{
"shape":"locale",
"documentation":"<p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
},
"maxResults":{
"shape":"maxResults",
"documentation":"<p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>"
}
}
},
"DescribeAffectedEntitiesForOrganizationResponse":{
"type":"structure",
"members":{
"entities":{
"shape":"EntityList",
"documentation":"<p>A JSON set of elements including the <code>awsAccountId</code> and its <code>entityArn</code>, <code>entityValue</code> and its <code>entityArn</code>, <code>lastUpdatedTime</code>, <code>statusCode</code>, and <code>tags</code>.</p>"
},
"failedSet":{
"shape":"DescribeAffectedEntitiesForOrganizationFailedSet",
"documentation":"<p>A JSON set of elements of the failed response, including the <code>awsAccountId</code>, <code>errorMessage</code>, <code>errorName</code>, and <code>eventArn</code>.</p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
}
}
},
"DescribeAffectedEntitiesRequest":{
"type":"structure",
"required":["filter"],
"members":{
"filter":{
"shape":"EntityFilter",
"documentation":"<p>Values to narrow the results returned. At least one event ARN is required. </p>"
"documentation":"<p>Values to narrow the results returned. At least one event ARN is required.</p>"
},
"locale":{
"shape":"locale",
@ -240,6 +417,41 @@
"type":"list",
"member":{"shape":"EventDetailsErrorItem"}
},
"DescribeEventDetailsForOrganizationFailedSet":{
"type":"list",
"member":{"shape":"OrganizationEventDetailsErrorItem"}
},
"DescribeEventDetailsForOrganizationRequest":{
"type":"structure",
"required":["organizationEventDetailFilters"],
"members":{
"organizationEventDetailFilters":{
"shape":"OrganizationEventDetailFiltersList",
"documentation":"<p>A set of JSON elements that includes the <code>awsAccountId</code> and the <code>eventArn</code>.</p>"
},
"locale":{
"shape":"locale",
"documentation":"<p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>"
}
}
},
"DescribeEventDetailsForOrganizationResponse":{
"type":"structure",
"members":{
"successfulSet":{
"shape":"DescribeEventDetailsForOrganizationSuccessfulSet",
"documentation":"<p>Information about the events that could be retrieved.</p>"
},
"failedSet":{
"shape":"DescribeEventDetailsForOrganizationFailedSet",
"documentation":"<p>Error messages for any events that could not be retrieved.</p>"
}
}
},
"DescribeEventDetailsForOrganizationSuccessfulSet":{
"type":"list",
"member":{"shape":"OrganizationEventDetails"}
},
"DescribeEventDetailsRequest":{
"type":"structure",
"required":["eventArns"],
@ -305,6 +517,40 @@
}
}
},
"DescribeEventsForOrganizationRequest":{
"type":"structure",
"members":{
"filter":{
"shape":"OrganizationEventFilter",
"documentation":"<p>Values to narrow the results returned.</p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
},
"maxResults":{
"shape":"maxResults",
"documentation":"<p>The maximum number of items to return in one batch, between 10 and 100, inclusive.</p>"
},
"locale":{
"shape":"locale",
"documentation":"<p>The locale (language) to return information in. English (en) is the default and the only supported value at this time.</p>"
}
}
},
"DescribeEventsForOrganizationResponse":{
"type":"structure",
"members":{
"events":{
"shape":"OrganizationEventList",
"documentation":"<p>The events that match the specified filter criteria.</p>"
},
"nextToken":{
"shape":"nextToken",
"documentation":"<p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.</p>"
}
}
},
"DescribeEventsRequest":{
"type":"structure",
"members":{
@ -339,6 +585,15 @@
}
}
},
"DescribeHealthServiceStatusForOrganizationResponse":{
"type":"structure",
"members":{
"healthServiceAccessStatusForOrganization":{
"shape":"healthServiceAccessStatusForOrganization",
"documentation":"<p>Information about the status of enabling or disabling AWS Health Organizational View in your organization.</p> <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>"
}
}
},
"EntityAggregate":{
"type":"structure",
"members":{
@ -436,7 +691,25 @@
"documentation":"<p>The most recent status of the event. Possible values are <code>open</code>, <code>closed</code>, and <code>upcoming</code>.</p>"
}
},
"documentation":"<p>Summary information about an event, returned by the <a>DescribeEvents</a> operation. The <a>DescribeEventDetails</a> operation also returns this information, as well as the <a>EventDescription</a> and additional event metadata.</p>"
"documentation":"<p>Summary information about an AWS Health event.</p>"
},
"EventAccountFilter":{
"type":"structure",
"required":[
"eventArn",
"awsAccountId"
],
"members":{
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"awsAccountId":{
"shape":"accountId",
"documentation":"<p>The 12-digit AWS account numbers that contains the affected entities.</p>"
}
},
"documentation":"<p>The values used to filter results from the <a>DescribeEventDetailsForOrganization</a> and <a>DescribeAffectedEntitiesForOrganization</a> operations.</p>"
},
"EventAggregate":{
"type":"structure",
@ -517,7 +790,7 @@
},
"eventTypeCodes":{
"shape":"eventTypeList",
"documentation":"<p>A list of unique identifiers for event types. For example, <code>\"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\"</code> </p>"
"documentation":"<p>A list of unique identifiers for event types. For example, <code>\"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".</code> </p>"
},
"services":{
"shape":"serviceList",
@ -630,6 +903,165 @@
"documentation":"<p>The specified pagination token (<code>nextToken</code>) is not valid.</p>",
"exception":true
},
"OrganizationAffectedEntitiesErrorItem":{
"type":"structure",
"members":{
"awsAccountId":{
"shape":"accountId",
"documentation":"<p>The 12-digit AWS account numbers that contains the affected entities.</p>"
},
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"errorName":{
"shape":"string",
"documentation":"<p>The name of the error.</p>"
},
"errorMessage":{
"shape":"string",
"documentation":"<p>The unique identifier for the event type. The format is <code>AWS_SERVICE_DESCRIPTION</code>. For example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>"
}
},
"documentation":"<p>Error information returned when a <a>DescribeAffectedEntitiesForOrganization</a> operation cannot find or process a specific entity.</p>"
},
"OrganizationEntityFiltersList":{
"type":"list",
"member":{"shape":"EventAccountFilter"},
"max":10,
"min":1
},
"OrganizationEvent":{
"type":"structure",
"members":{
"arn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"service":{
"shape":"service",
"documentation":"<p>The AWS service that is affected by the event. For example, EC2, RDS.</p>"
},
"eventTypeCode":{
"shape":"eventTypeCode",
"documentation":"<p>The unique identifier for the event type. The format is <code>AWS_SERVICE_DESCRIPTION</code>. For example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>.</p>"
},
"eventTypeCategory":{
"shape":"eventTypeCategory",
"documentation":"<p>The category of the event type.</p>"
},
"region":{
"shape":"region",
"documentation":"<p>The AWS Region name of the event.</p>"
},
"startTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that the event began.</p>"
},
"endTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that the event ended.</p>"
},
"lastUpdatedTime":{
"shape":"timestamp",
"documentation":"<p>The most recent date and time that the event was updated.</p>"
},
"statusCode":{
"shape":"eventStatusCode",
"documentation":"<p>The most recent status of the event. Possible values are <code>open</code>, <code>closed</code>, and <code>upcoming</code>.</p>"
}
},
"documentation":"<p>Summary information about an event, returned by the <a>DescribeEventsForOrganization</a> operation.</p>"
},
"OrganizationEventDetailFiltersList":{
"type":"list",
"member":{"shape":"EventAccountFilter"},
"max":10,
"min":1
},
"OrganizationEventDetails":{
"type":"structure",
"members":{
"awsAccountId":{
"shape":"accountId",
"documentation":"<p>The 12-digit AWS account numbers that contains the affected entities.</p>"
},
"event":{"shape":"Event"},
"eventDescription":{"shape":"EventDescription"},
"eventMetadata":{
"shape":"eventMetadata",
"documentation":"<p>Additional metadata about the event.</p>"
}
},
"documentation":"<p>Detailed information about an event. A combination of an <a>Event</a> object, an <a>EventDescription</a> object, and additional metadata about the event. Returned by the <a>DescribeEventDetailsForOrganization</a> operation.</p>"
},
"OrganizationEventDetailsErrorItem":{
"type":"structure",
"members":{
"awsAccountId":{
"shape":"accountId",
"documentation":"<p>Error information returned when a <a>DescribeEventDetailsForOrganization</a> operation cannot find a specified event.</p>"
},
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"errorName":{
"shape":"string",
"documentation":"<p>The name of the error.</p>"
},
"errorMessage":{
"shape":"string",
"documentation":"<p>A message that describes the error.</p>"
}
},
"documentation":"<p>Error information returned when a <a>DescribeEventDetailsForOrganization</a> operation cannot find a specified event.</p>"
},
"OrganizationEventFilter":{
"type":"structure",
"members":{
"eventTypeCodes":{
"shape":"eventTypeList",
"documentation":"<p>A list of unique identifiers for event types. For example, <code>\"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".</code> </p>"
},
"awsAccountIds":{
"shape":"awsAccountIdsList",
"documentation":"<p>A list of 12-digit AWS account numbers that contains the affected entities.</p>"
},
"services":{
"shape":"serviceList",
"documentation":"<p>The AWS services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>"
},
"regions":{
"shape":"regionList",
"documentation":"<p>A list of AWS Regions.</p>"
},
"startTime":{"shape":"DateTimeRange"},
"endTime":{"shape":"DateTimeRange"},
"lastUpdatedTime":{"shape":"DateTimeRange"},
"entityArns":{
"shape":"entityArnList",
"documentation":"<p>REPLACEME</p>"
},
"entityValues":{
"shape":"entityValueList",
"documentation":"<p>A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).</p>"
},
"eventTypeCategories":{
"shape":"eventTypeCategoryList",
"documentation":"<p>REPLACEME</p>"
},
"eventStatusCodes":{
"shape":"eventStatusCodeList",
"documentation":"<p>A list of event status codes.</p>"
}
},
"documentation":"<p>The values to filter results from the <a>DescribeEventsForOrganization</a> operation.</p>"
},
"OrganizationEventList":{
"type":"list",
"member":{"shape":"OrganizationEvent"}
},
"UnsupportedLocale":{
"type":"structure",
"members":{
@ -640,17 +1072,30 @@
},
"accountId":{
"type":"string",
"pattern":"[0-9]{12}"
"max":12,
"pattern":"^\\S+$"
},
"affectedAccountsList":{
"type":"list",
"member":{"shape":"accountId"}
},
"aggregateValue":{"type":"string"},
"availabilityZone":{
"type":"string",
"max":18,
"min":6,
"pattern":"[a-z]{2}\\-[0-9a-z\\-]{4,16}"
},
"availabilityZones":{
"type":"list",
"member":{"shape":"availabilityZone"}
},
"awsAccountIdsList":{
"type":"list",
"member":{"shape":"accountId"},
"max":50,
"min":1
},
"count":{"type":"integer"},
"dateTimeRangeList":{
"type":"list",
@ -660,7 +1105,8 @@
},
"entityArn":{
"type":"string",
"max":1600
"max":1600,
"pattern":".{0,1600}"
},
"entityArnList":{
"type":"list",
@ -682,13 +1128,11 @@
"max":3,
"min":1
},
"entityUrl":{
"type":"string",
"pattern":"https?://.+\\.(amazon\\.com|amazonaws\\.com|amazonaws\\.cn|c2s\\.ic\\.gov|sc2s\\.sgov\\.gov|amazonaws-us-gov.com)/.*"
},
"entityUrl":{"type":"string"},
"entityValue":{
"type":"string",
"max":256
"max":256,
"pattern":".{0,256}"
},
"entityValueList":{
"type":"list",
@ -734,7 +1178,8 @@
"eventType":{
"type":"string",
"max":100,
"min":3
"min":3,
"pattern":"[^:/]{3,100}"
},
"eventTypeCategory":{
"type":"string",
@ -756,7 +1201,8 @@
"eventTypeCode":{
"type":"string",
"max":100,
"min":3
"min":3,
"pattern":"[a-zA-Z0-9\\_\\-]{3,100}"
},
"eventTypeList":{
"type":"list",
@ -764,10 +1210,12 @@
"max":10,
"min":1
},
"healthServiceAccessStatusForOrganization":{"type":"string"},
"locale":{
"type":"string",
"max":256,
"min":2
"min":2,
"pattern":".{2,256}"
},
"maxResults":{
"type":"integer",
@ -781,10 +1229,14 @@
},
"nextToken":{
"type":"string",
"pattern":"[a-zA-Z0-9=/+_.-]{4,512}"
"max":10000,
"min":4,
"pattern":"[a-zA-Z0-9=/+_.-]{4,10000}"
},
"region":{
"type":"string",
"max":25,
"min":2,
"pattern":"[^:/]{2,25}"
},
"regionList":{
@ -796,7 +1248,8 @@
"service":{
"type":"string",
"max":30,
"min":2
"min":2,
"pattern":"[^:/]{2,30}"
},
"serviceList":{
"type":"list",
@ -812,7 +1265,8 @@
},
"tagKey":{
"type":"string",
"max":127
"max":127,
"pattern":".{0,127}"
},
"tagSet":{
"type":"map",
@ -822,9 +1276,10 @@
},
"tagValue":{
"type":"string",
"max":255
"max":255,
"pattern":".{0,255}"
},
"timestamp":{"type":"timestamp"}
},
"documentation":"<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>. </p> <p>For authentication of requests, AWS Health uses the <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p> <p>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>"
"documentation":"<fullname>AWS Health</fullname> <p>The AWS Health API provides programmatic access to the AWS Health information that is presented in the <a href=\"https://phd.aws.amazon.com/phd/home#/\">AWS Personal Health Dashboard</a>. You can get information about events that affect your AWS resources:</p> <ul> <li> <p> <a>DescribeEvents</a>: Summary information about events.</p> </li> <li> <p> <a>DescribeEventDetails</a>: Detailed information about one or more events.</p> </li> <li> <p> <a>DescribeAffectedEntities</a>: Information about AWS resources that are affected by one or more events.</p> </li> </ul> <p>In addition, these operations provide information about event types and summary counts of events or affected entities:</p> <ul> <li> <p> <a>DescribeEventTypes</a>: Information about the kinds of events that AWS Health tracks.</p> </li> <li> <p> <a>DescribeEventAggregates</a>: A count of the number of events that meet specified criteria.</p> </li> <li> <p> <a>DescribeEntityAggregates</a>: A count of the number of affected entities that meet specified criteria.</p> </li> </ul> <p>AWS Health integrates with AWS Organizations to provide a centralized view of AWS Health events across all accounts in your organization.</p> <ul> <li> <p> <a>DescribeEventsForOrganization</a>: Summary information about events across the organization.</p> </li> <li> <p> <a>DescribeAffectedAccountsForOrganization</a>: List of accounts in your organization impacted by an event.</p> </li> <li> <p> <a>DescribeEventDetailsForOrganization</a>: Detailed information about events in your organization.</p> </li> <li> <p> <a>DescribeAffectedEntitiesForOrganization</a>: Information about AWS resources in your organization that are affected by events.</p> </li> </ul> <p>You can use the following operations to enable or disable AWS Health from working with AWS Organizations.</p> <ul> <li> <p> <a>EnableHealthServiceAccessForOrganization</a>: Enables AWS Health to work with AWS Organizations.</p> </li> <li> <p> <a>DisableHealthServiceAccessForOrganization</a>: Disables AWS Health from working with AWS Organizations.</p> </li> <li> <p> <a>DescribeHealthServiceStatusForOrganization</a>: Status information about enabling or disabling AWS Health from working with AWS Organizations.</p> </li> </ul> <p>The Health API requires a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a>. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a <code>SubscriptionRequiredException</code>.</p> <p>For authentication of requests, AWS Health uses the <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>.</p> <p>See the <a href=\"https://docs.aws.amazon.com/health/latest/ug/what-is-aws-health.html\">AWS Health User Guide</a> for information about how to use the API.</p> <p> <b>Service Endpoint</b> </p> <p>The HTTP endpoint for the AWS Health API is:</p> <ul> <li> <p>https://health.us-east-1.amazonaws.com </p> </li> </ul>"
}

View file

@ -230,7 +230,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>.</p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.</p> <p>When you create the IAM OIDC provider, you specify the following:</p> <ul> <li> <p>The URL of the OIDC identity provider (IdP) to trust</p> </li> <li> <p>A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider</p> </li> <li> <p>A list of thumbprints of the server certificate(s) that the IdP uses</p> </li> </ul> <p>You get all of this information from the OIDC IdP that you want to use to access AWS.</p> <note> <p>The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged users.</p> </note>"
"documentation":"<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>.</p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.</p> <p>When you create the IAM OIDC provider, you specify the following:</p> <ul> <li> <p>The URL of the OIDC identity provider (IdP) to trust</p> </li> <li> <p>A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider</p> </li> <li> <p>A list of thumbprints of one or more server certificates that the IdP uses</p> </li> </ul> <p>You get all of this information from the OIDC IdP that you want to use to access AWS.</p> <note> <p>The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the <a>CreateOpenIDConnectProvider</a> operation to highly privileged users.</p> </note>"
},
"CreatePolicy":{
"name":"CreatePolicy",
@ -1932,7 +1932,7 @@
{"shape":"InvalidInputException"},
{"shape":"PolicyEvaluationException"}
],
"documentation":"<p>Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings.</p> <p>The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.</p> <p>If you want to simulate existing policies attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead.</p> <p>Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>.</p> <p>If the output is long, you can use <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results.</p>"
"documentation":"<p>Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings.</p> <p>The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.</p> <p>If you want to simulate existing policies that are attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead.</p> <p>Context keys are variables that are maintained by AWS and its services and which provide details about the context of an API query request. You can use the <code>Condition</code> element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use <a>GetContextKeysForCustomPolicy</a>.</p> <p>If the output is long, you can use <code>MaxItems</code> and <code>Marker</code> parameters to paginate the results.</p>"
},
"SimulatePrincipalPolicy":{
"name":"SimulatePrincipalPolicy",
@ -2563,7 +2563,7 @@
},
"NewPassword":{
"shape":"passwordType",
"documentation":"<p>The new password. The new password must conform to the AWS account's password policy, if one exists.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.</p>"
"documentation":"<p>The new password. The new password must conform to the AWS account's password policy, if one exists.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (<code>\\u0020</code>) through the end of the ASCII character range (<code>\\u00FF</code>). You can also include the tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.</p>"
}
}
},
@ -2671,7 +2671,7 @@
"members":{
"Path":{
"shape":"pathType",
"documentation":"<p> The path to the group. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path to the group. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"GroupName":{
"shape":"groupNameType",
@ -2700,7 +2700,7 @@
},
"Path":{
"shape":"pathType",
"documentation":"<p> The path to the instance profile. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path to the instance profile. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
}
}
},
@ -2728,7 +2728,7 @@
},
"Password":{
"shape":"passwordType",
"documentation":"<p>The new password for the user.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.</p>"
"documentation":"<p>The new password for the user.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (<code>\\u0020</code>) through the end of the ASCII character range (<code>\\u00FF</code>). You can also include the tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.</p>"
},
"PasswordResetRequired":{
"shape":"booleanType",
@ -2791,11 +2791,11 @@
},
"Path":{
"shape":"policyPathType",
"documentation":"<p>The path for the policy.</p> <p>For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path for the policy.</p> <p>For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The JSON policy document that you want to use as the content for the new policy.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The JSON policy document that you want to use as the content for the new policy.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"Description":{
"shape":"policyDescriptionType",
@ -2826,7 +2826,7 @@
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The JSON policy document that you want to use as the content for this new version of the policy.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The JSON policy document that you want to use as the content for this new version of the policy.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"SetAsDefault":{
"shape":"booleanType",
@ -2853,7 +2853,7 @@
"members":{
"Path":{
"shape":"pathType",
"documentation":"<p> The path to the role. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path to the role. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"RoleName":{
"shape":"roleNameType",
@ -2861,7 +2861,7 @@
},
"AssumeRolePolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The trust relationship policy document that grants an entity permission to assume the role.</p> <p>In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul> <p> Upon success, the response includes the same trust policy in JSON format.</p>"
"documentation":"<p>The trust relationship policy document that grants an entity permission to assume the role.</p> <p>In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul> <p> Upon success, the response includes the same trust policy in JSON format.</p>"
},
"Description":{
"shape":"roleDescriptionType",
@ -2978,7 +2978,7 @@
"members":{
"Path":{
"shape":"pathType",
"documentation":"<p> The path for the user name. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path for the user name. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"UserName":{
"shape":"userNameType",
@ -3010,7 +3010,7 @@
"members":{
"Path":{
"shape":"pathType",
"documentation":"<p> The path for the virtual MFA device. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path for the virtual MFA device. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/).</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"VirtualMFADeviceName":{
"shape":"virtualMFADeviceName",
@ -3646,9 +3646,13 @@
"shape":"OrganizationsDecisionDetail",
"documentation":"<p>A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.</p>"
},
"PermissionsBoundaryDecisionDetail":{
"shape":"PermissionsBoundaryDecisionDetail",
"documentation":"<p>Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.</p>"
},
"EvalDecisionDetails":{
"shape":"EvalDecisionDetailsType",
"documentation":"<p>Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html\">How IAM Roles Differ from Resource-based Policies</a> </p>"
"documentation":"<p>Additional details about the results of the cross-account evaluation decision. This parameter is populated for only cross-account simulations. It contains a brief summary of how each policy type contributes to the final evaluation decision.</p> <p>If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is present but the response is empty. If the simulation evaluates policies within the same account and specifies all resources (<code>*</code>), then the parameter is not returned.</p> <p>When you make a cross-account request, AWS evaluates the request in the trusting account and the trusted account. The request is allowed only if both evaluations return <code>true</code>. For more information about how policies are evaluated, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-basics\">Evaluating Policies Within a Single Account</a>.</p> <p>If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy evaluation does not proceed any further and this parameter is not returned.</p>"
},
"ResourceSpecificResults":{
"shape":"ResourceSpecificResultListType",
@ -3815,7 +3819,7 @@
"members":{
"PolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -3839,7 +3843,7 @@
},
"PolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>An optional list of additional policies for which you want the list of context keys that are referenced.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>An optional list of additional policies for which you want the list of context keys that are referenced.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -4749,7 +4753,7 @@
},
"PathPrefix":{
"shape":"policyPathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -4789,7 +4793,7 @@
},
"PathPrefix":{
"shape":"policyPathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -4829,7 +4833,7 @@
},
"PathPrefix":{
"shape":"policyPathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -4873,7 +4877,7 @@
},
"PathPrefix":{
"shape":"pathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"PolicyUsageFilter":{
"shape":"PolicyUsageType",
@ -4994,7 +4998,7 @@
"members":{
"PathPrefix":{
"shape":"pathPrefixType",
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/division_abc/subdivision_xyz/</code> gets all groups whose path starts with <code>/division_abc/subdivision_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/division_abc/subdivision_xyz/</code> gets all groups whose path starts with <code>/division_abc/subdivision_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -5067,7 +5071,7 @@
"members":{
"PathPrefix":{
"shape":"pathPrefixType",
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all instance profiles whose path starts with <code>/application_abc/component_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all instance profiles whose path starts with <code>/application_abc/component_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -5215,7 +5219,7 @@
},
"PathPrefix":{
"shape":"policyPathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"PolicyUsageFilter":{
"shape":"PolicyUsageType",
@ -5363,7 +5367,7 @@
"members":{
"PathPrefix":{
"shape":"pathPrefixType",
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all roles whose path starts with <code>/application_abc/component_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path prefix for filtering the results. For example, the prefix <code>/application_abc/component_xyz/</code> gets all roles whose path starts with <code>/application_abc/component_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -5449,7 +5453,7 @@
"members":{
"PathPrefix":{
"shape":"pathPrefixType",
"documentation":"<p> The path prefix for filtering the results. For example: <code>/company/servercerts</code> would get all server certificates for which the path starts with <code>/company/servercerts</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path prefix for filtering the results. For example: <code>/company/servercerts</code> would get all server certificates for which the path starts with <code>/company/servercerts</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -5616,7 +5620,7 @@
"members":{
"PathPrefix":{
"shape":"pathPrefixType",
"documentation":"<p> The path prefix for filtering the results. For example: <code>/division_abc/subdivision_xyz/</code>, which would get all user names whose path starts with <code>/division_abc/subdivision_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p> The path prefix for filtering the results. For example: <code>/division_abc/subdivision_xyz/</code>, which would get all user names whose path starts with <code>/division_abc/subdivision_xyz/</code>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"Marker":{
"shape":"markerType",
@ -5913,6 +5917,16 @@
"type":"string",
"enum":["PermissionsBoundaryPolicy"]
},
"PermissionsBoundaryDecisionDetail":{
"type":"structure",
"members":{
"AllowedByPermissionsBoundary":{
"shape":"booleanType",
"documentation":"<p>Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role). A value of <code>true</code> means that the permissions boundary does not deny the action. This means that the policy includes an <code>Allow</code> statement that matches the request. In this case, if an identity-based policy also allows the action, the request is allowed. A value of <code>false</code> means that either the requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.</p>"
}
},
"documentation":"<p>Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is applied to an IAM entity.</p>"
},
"Policy":{
"type":"structure",
"members":{
@ -6163,7 +6177,7 @@
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -6202,7 +6216,7 @@
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -6241,7 +6255,7 @@
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The policy document.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -6394,7 +6408,11 @@
},
"EvalDecisionDetails":{
"shape":"EvalDecisionDetailsType",
"documentation":"<p>Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access.</p>"
"documentation":"<p>Additional details about the results of the evaluation decision on a single resource. This parameter is returned only for cross-account simulations. This parameter explains how each policy type contributes to the resource-specific evaluation decision.</p>"
},
"PermissionsBoundaryDecisionDetail":{
"shape":"PermissionsBoundaryDecisionDetail",
"documentation":"<p>Contains information about the effect that a permissions boundary has on a policy simulation when that boundary is applied to an IAM entity.</p>"
}
},
"documentation":"<p>Contains the result of the simulation of a single API operation call on a single resource.</p> <p>This data type is used by a member of the <a>EvaluationResult</a> data type.</p>"
@ -6942,7 +6960,11 @@
"members":{
"PolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the <code>ResourcePolicy</code> parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html\">GetFederationToken</a> or one of the <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html\">AssumeRole</a> API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the <code>ResourcePolicy</code> parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetFederationToken.html\">GetFederationToken</a> or one of the <a href=\"https://docs.aws.amazon.com/IAM/latest/APIReference/API_AssumeRole.html\">AssumeRole</a> API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"PermissionsBoundaryPolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Entities</a> in the <i>IAM User Guide</i>. The policy input is specified as a string that contains the complete, valid JSON text of a permissions boundary policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"ActionNames":{
"shape":"ActionNameListType",
@ -6954,7 +6976,7 @@
},
"ResourcePolicy":{
"shape":"policyDocumentType",
"documentation":"<p>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"ResourceOwner":{
"shape":"ResourceNameType",
@ -7013,7 +7035,11 @@
},
"PolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"PermissionsBoundaryPolicyInputList":{
"shape":"SimulationPolicyListType",
"documentation":"<p>The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new permission boundary policy is used for the simulation. For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Entities</a> in the <i>IAM User Guide</i>. The policy input is specified as a string containing the complete, valid JSON text of a permissions boundary policy.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"ActionNames":{
"shape":"ActionNameListType",
@ -7025,7 +7051,7 @@
},
"ResourcePolicy":{
"shape":"policyDocumentType",
"documentation":"<p>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"ResourceOwner":{
"shape":"ResourceNameType",
@ -7270,7 +7296,7 @@
},
"PolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The policy that grants an entity permission to assume the role.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The policy that grants an entity permission to assume the role.</p> <p>You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -7284,7 +7310,7 @@
},
"NewPath":{
"shape":"pathType",
"documentation":"<p>New path for the IAM group. Only include this if changing the group's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>New path for the IAM group. Only include this if changing the group's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"NewGroupName":{
"shape":"groupNameType",
@ -7302,7 +7328,7 @@
},
"Password":{
"shape":"passwordType",
"documentation":"<p>The new password for the specified IAM user.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul> <p>However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see <a>UpdateAccountPasswordPolicy</a>.</p>"
"documentation":"<p>The new password for the specified IAM user.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul> <p>However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see <a>UpdateAccountPasswordPolicy</a>.</p>"
},
"PasswordResetRequired":{
"shape":"booleanObjectType",
@ -7435,7 +7461,7 @@
},
"NewPath":{
"shape":"pathType",
"documentation":"<p>The new path for the server certificate. Include this only if you are updating the server certificate's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>The new path for the server certificate. Include this only if you are updating the server certificate's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"NewServerCertificateName":{
"shape":"serverCertificateNameType",
@ -7495,7 +7521,7 @@
},
"NewPath":{
"shape":"pathType",
"documentation":"<p>New path for the IAM user. Include this parameter only if you're changing the user's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
"documentation":"<p>New path for the IAM user. Include this parameter only if you're changing the user's path.</p> <p>This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"NewUserName":{
"shape":"userNameType",
@ -7516,7 +7542,7 @@
},
"SSHPublicKeyBody":{
"shape":"publicKeyMaterialType",
"documentation":"<p>The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -7540,7 +7566,7 @@
"members":{
"Path":{
"shape":"pathType",
"documentation":"<p>The path for the server certificate. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p> <note> <p> If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the <code>path</code> parameter. The path must begin with <code>/cloudfront</code> and must include a trailing slash (for example, <code>/cloudfront/test/</code>).</p> </note>"
"documentation":"<p>The path for the server certificate. For more information about paths, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>.</p> <p>This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (<code>\\u0021</code>) through the DEL character (<code>\\u007F</code>), including most punctuation characters, digits, and upper and lowercased letters.</p> <note> <p> If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the <code>path</code> parameter. The path must begin with <code>/cloudfront</code> and must include a trailing slash (for example, <code>/cloudfront/test/</code>).</p> </note>"
},
"ServerCertificateName":{
"shape":"serverCertificateNameType",
@ -7548,15 +7574,15 @@
},
"CertificateBody":{
"shape":"certificateBodyType",
"documentation":"<p>The contents of the public key certificate in PEM-encoded format.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The contents of the public key certificate in PEM-encoded format.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"PrivateKey":{
"shape":"privateKeyType",
"documentation":"<p>The contents of the private key in PEM-encoded format.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The contents of the private key in PEM-encoded format.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
},
"CertificateChain":{
"shape":"certificateChainType",
"documentation":"<p>The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},
@ -7580,7 +7606,7 @@
},
"CertificateBody":{
"shape":"certificateBodyType",
"documentation":"<p>The contents of the signing certificate.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The contents of the signing certificate.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (<code>\\u0020</code>) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\\u00FF</code>)</p> </li> <li> <p>The special characters tab (<code>\\u0009</code>), line feed (<code>\\u000A</code>), and carriage return (<code>\\u000D</code>)</p> </li> </ul>"
}
}
},

View file

@ -31,7 +31,7 @@
{"shape":"CallRateLimitExceededException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>CancelImageCreation cancels the creation of Image. This operation may only be used on images in a non-terminal state.</p>"
"documentation":"<p>CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.</p>"
},
"CreateComponent":{
"name":"CreateComponent",
@ -53,7 +53,7 @@
{"shape":"ResourceInUseException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Creates a new component that can be used to build, validate, test and assess your image.</p>"
"documentation":"<p>Creates a new component that can be used to build, validate, test, and assess your image.</p>"
},
"CreateDistributionConfiguration":{
"name":"CreateDistributionConfiguration",
@ -75,7 +75,7 @@
{"shape":"ResourceAlreadyExistsException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p> Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. </p>"
"documentation":"<p>Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline. </p>"
},
"CreateImage":{
"name":"CreateImage",
@ -138,7 +138,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceAlreadyExistsException"}
],
"documentation":"<p> Creates a new image recipe. Image Recipes defines how images are configured, tested and assessed. </p>"
"documentation":"<p> Creates a new image recipe. Image recipes define how images are configured, tested, and assessed. </p>"
},
"CreateInfrastructureConfiguration":{
"name":"CreateInfrastructureConfiguration",
@ -435,7 +435,7 @@
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p> Gets a infrastructure configuration. </p>"
"documentation":"<p> Gets an infrastructure configuration. </p>"
},
"ImportComponent":{
"name":"ImportComponent",
@ -457,7 +457,7 @@
{"shape":"ResourceInUseException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p> Imports a component and transforms its data into a component document. </p>"
"documentation":"<p>Imports a component and transforms its data into a component document. </p>"
},
"ListComponentBuildVersions":{
"name":"ListComponentBuildVersions",
@ -495,7 +495,7 @@
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p> Returns the list of component build versions for the specified semantic version. </p>"
"documentation":"<p>Returns the list of component build versions for the specified semantic version. </p>"
},
"ListDistributionConfigurations":{
"name":"ListDistributionConfigurations",
@ -829,7 +829,7 @@
"members":{
"region":{
"shape":"NonEmptyString",
"documentation":"<p> The region of the EC2 AMI. </p>"
"documentation":"<p> The AWS Region of the EC2 AMI. </p>"
},
"image":{
"shape":"NonEmptyString",
@ -851,7 +851,7 @@
"type":"structure",
"members":{
"name":{
"shape":"NonEmptyString",
"shape":"AmiNameString",
"documentation":"<p> The name of the distribution configuration. </p>"
},
"description":{
@ -860,19 +860,25 @@
},
"amiTags":{
"shape":"TagMap",
"documentation":"<p> The tags to apply to AMIs distributed to this region. </p>"
"documentation":"<p> The tags to apply to AMIs distributed to this Region. </p>"
},
"launchPermission":{
"shape":"LaunchPermissionConfiguration",
"documentation":"<p> Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances. </p>"
}
},
"documentation":"<p> Define and configure the outputs AMIs of the pipeline. </p>"
"documentation":"<p> Define and configure the output AMIs of the pipeline. </p>"
},
"AmiList":{
"type":"list",
"member":{"shape":"Ami"}
},
"AmiNameString":{
"type":"string",
"max":127,
"min":1,
"pattern":"^[-_A-Za-z0-9{][-_A-Za-z0-9\\s:{}]+[-_A-Za-z0-9}]$"
},
"Arn":{"type":"string"},
"ArnList":{
"type":"list",
@ -896,11 +902,12 @@
"members":{
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the image whose creation you wish to cancel.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image whose creation you want to cancel.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The idempotency token used to make this request idempotent.</p>"
"documentation":"<p>The idempotency token used to make this request idempotent.</p>",
"idempotencyToken":true
}
}
},
@ -1002,7 +1009,7 @@
"required":["componentArn"],
"members":{
"componentArn":{
"shape":"ComponentBuildVersionArn",
"shape":"ComponentVersionArnOrBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component. </p>"
}
},
@ -1062,7 +1069,7 @@
"documentation":"<p>The tags associated with the component.</p>"
}
},
"documentation":"<p>A high level summary of a component.</p>"
"documentation":"<p>A high-level summary of a component.</p>"
},
"ComponentSummaryList":{
"type":"list",
@ -1111,12 +1118,16 @@
"documentation":"<p>The date that the component was created.</p>"
}
},
"documentation":"<p>A high level overview of a component semantic version.</p>"
"documentation":"<p>A high-level overview of a component semantic version.</p>"
},
"ComponentVersionArn":{
"type":"string",
"pattern":"^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):component/[a-z0-9-_]+/\\d+\\.\\d+\\.\\d+$"
},
"ComponentVersionArnOrBuildVersionArn":{
"type":"string",
"pattern":"^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):component/[a-z0-9-_]+/(?:(?:(\\d+|x)\\.(\\d+|x)\\.(\\d+|x))|(?:\\d+\\.\\d+\\.\\d+/\\d+))$"
},
"ComponentVersionList":{
"type":"list",
"member":{"shape":"ComponentVersion"}
@ -1136,27 +1147,27 @@
},
"semanticVersion":{
"shape":"VersionNumber",
"documentation":"<p>The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.</p>"
"documentation":"<p>The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).</p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p>CThe description of the component. Describes the contents of the component.</p>"
"documentation":"<p>The description of the component. Describes the contents of the component.</p>"
},
"changeDescription":{
"shape":"NonEmptyString",
"documentation":"<p>CThe change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component.</p>"
"documentation":"<p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.</p>"
},
"platform":{
"shape":"Platform",
"documentation":"<p>CThe platform of the component.</p>"
"documentation":"<p>The platform of the component.</p>"
},
"data":{
"shape":"InlineComponentData",
"documentation":"<p>CThe data of the component.</p>"
"documentation":"<p>The data of the component. Used to specify the data inline. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>"
},
"uri":{
"shape":"Uri",
"documentation":"<p>CThe uri of the component.</p>"
"documentation":"<p>The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>"
},
"kmsKeyId":{
"shape":"NonEmptyString",
@ -1164,11 +1175,11 @@
},
"tags":{
"shape":"TagMap",
"documentation":"<p>CThe tags of the component.</p>"
"documentation":"<p>The tags of the component.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>CThe idempotency token of the component.</p>",
"documentation":"<p>The idempotency token of the component.</p>",
"idempotencyToken":true
}
}
@ -1178,15 +1189,15 @@
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p>CThe request ID that uniquely identifies this request.</p>"
"documentation":"<p>The request ID that uniquely identifies this request.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>CThe idempotency token used to make this request idempotent.</p>"
"documentation":"<p>The idempotency token used to make this request idempotent.</p>"
},
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p>CThe Amazon Resource Name (ARN) of the component that was created by this request.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the component that was created by this request.</p>"
}
}
},
@ -1379,7 +1390,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested and assessed. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. </p>"
},
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
@ -1439,7 +1450,7 @@
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p> The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability. </p>"
"documentation":"<p> The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
@ -1451,7 +1462,7 @@
},
"subnetId":{
"shape":"NonEmptyString",
"documentation":"<p> The subnet ID to place the instance used to customize your EC2 AMI in. </p>"
"documentation":"<p> The subnet ID in which to place the instance used to customize your EC2 AMI. </p>"
},
"logging":{
"shape":"Logging",
@ -1459,14 +1470,14 @@
},
"keyPair":{
"shape":"NonEmptyString",
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image. </p>"
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
},
"terminateInstanceOnFailure":{
"shape":"NullableBoolean",
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed. </p>"
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
},
"snsTopicArn":{
"shape":"NonEmptyString",
"shape":"SnsTopicArn",
"documentation":"<p> The SNS topic on which to send image build events. </p>"
},
"tags":{
@ -1654,18 +1665,18 @@
"members":{
"region":{
"shape":"NonEmptyString",
"documentation":"<p> </p>"
"documentation":"<p> The target Region. </p>"
},
"amiDistributionConfiguration":{
"shape":"AmiDistributionConfiguration",
"documentation":"<p> </p>"
"documentation":"<p> The specific AMI settings (for example, launch permissions, AMI tags). </p>"
},
"licenseConfigurationArns":{
"shape":"ArnList",
"documentation":"<p> </p>"
"documentation":"<p> The License Manager Configuration to associate with the AMI in the specified Region.</p>"
}
},
"documentation":"<p> </p>"
"documentation":"<p> Defines the settings for a specific Region. </p>"
},
"DistributionConfiguration":{
"type":"structure",
@ -1738,7 +1749,7 @@
"documentation":"<p>The tags associated with the distribution configuration.</p>"
}
},
"documentation":"<p>A high level overview a distribution configuration.</p>"
"documentation":"<p>A high-level overview of a distribution configuration.</p>"
},
"DistributionConfigurationSummaryList":{
"type":"list",
@ -1785,7 +1796,7 @@
"documentation":"<p>Use to override the device's volume type.</p>"
}
},
"documentation":"<p>EBS specific block device mapping specifications.</p>"
"documentation":"<p>Amazon EBS-specific block device mapping specifications.</p>"
},
"EbsIopsInteger":{
"type":"integer",
@ -1807,20 +1818,25 @@
"st1"
]
},
"EmptyString":{
"type":"string",
"max":0,
"min":0
},
"ErrorMessage":{"type":"string"},
"Filter":{
"type":"structure",
"members":{
"name":{
"shape":"FilterName",
"documentation":"<p> </p>"
"documentation":"<p> The name of the filter. Filter names are case-sensitive. </p>"
},
"values":{
"shape":"FilterValues",
"documentation":"<p> </p>"
"documentation":"<p> The filter values. Filter values are case-sensitive. </p>"
}
},
"documentation":"<p> </p>"
"documentation":"<p> A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. </p>"
},
"FilterList":{
"type":"list",
@ -1857,7 +1873,7 @@
"members":{
"componentArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component whose policy you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the component whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"componentArn"
}
@ -1882,7 +1898,7 @@
"members":{
"componentBuildVersionArn":{
"shape":"ComponentBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the component that you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires \"/\\d+$\" suffix.</p>",
"location":"querystring",
"locationName":"componentBuildVersionArn"
}
@ -1907,7 +1923,7 @@
"members":{
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve. </p>",
"location":"querystring",
"locationName":"distributionConfigurationArn"
}
@ -1932,7 +1948,7 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imagePipelineArn"
}
@ -1957,7 +1973,7 @@
"members":{
"imageArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose policy you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageArn"
}
@ -1982,7 +1998,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe whose policy you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe whose policy you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageRecipeArn"
}
@ -2007,7 +2023,7 @@
"members":{
"imageRecipeArn":{
"shape":"ImageRecipeArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageRecipeArn"
}
@ -2032,7 +2048,7 @@
"members":{
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the image that you want to retrieve. </p>",
"location":"querystring",
"locationName":"imageBuildVersionArn"
}
@ -2057,7 +2073,7 @@
"members":{
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to retrieve. </p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve. </p>",
"location":"querystring",
"locationName":"infrastructureConfigurationArn"
}
@ -2076,14 +2092,14 @@
"documentation":"<p> The infrastructure configuration object. </p>"
}
},
"documentation":"<p> GetInfrastructureConfiguration response object. </p>"
"documentation":"<p>GetInfrastructureConfiguration response object. </p>"
},
"IdempotentParameterMismatchException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>You have specified an client token for an operation using parameter values that differ from a previous request that used the same client token.</p>",
"documentation":"<p>You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -2182,7 +2198,7 @@
},
"infrastructureConfigurationArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastruction configuration associated with this image pipeline.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.</p>"
},
"distributionConfigurationArn":{
"shape":"Arn",
@ -2335,7 +2351,7 @@
"documentation":"<p> The reason for the image's status. </p>"
}
},
"documentation":"<p> Image state shows the images status and the reason for that status. </p>"
"documentation":"<p> Image state shows the image status and the reason for that status. </p>"
},
"ImageStatus":{
"type":"string",
@ -2408,7 +2424,7 @@
},
"timeoutMinutes":{
"shape":"ImageTestsTimeoutMinutes",
"documentation":"<p>The maximum time in minutes that tests are permitted to run for.</p>"
"documentation":"<p>The maximum time in minutes that tests are permitted to run.</p>"
}
},
"documentation":"<p>Image tests configuration.</p>"
@ -2423,7 +2439,7 @@
"members":{
"arn":{
"shape":"ImageBuilderArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the image semantic verion.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the image semantic version.</p>"
},
"name":{
"shape":"ResourceName",
@ -2473,23 +2489,23 @@
},
"semanticVersion":{
"shape":"VersionNumber",
"documentation":"<p> The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01. </p>"
"documentation":"<p>The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).</p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p> The description of the component. Describes the contents of the component. </p>"
"documentation":"<p>The description of the component. Describes the contents of the component. </p>"
},
"changeDescription":{
"shape":"NonEmptyString",
"documentation":"<p> The change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component. </p>"
"documentation":"<p> The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component. </p>"
},
"type":{
"shape":"ComponentType",
"documentation":"<p> The type of the component denotes whether the component is used to build the image or only to test it. </p>"
"documentation":"<p>The type of the component denotes whether the component is used to build the image or only to test it. </p>"
},
"format":{
"shape":"ComponentFormat",
"documentation":"<p> The format of the resource that you wish to import as a component. </p>"
"documentation":"<p> The format of the resource that you want to import as a component. </p>"
},
"platform":{
"shape":"Platform",
@ -2497,11 +2513,11 @@
},
"data":{
"shape":"NonEmptyString",
"documentation":"<p> The data of the component. </p>"
"documentation":"<p>The data of the component. Used to specify the data inline. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component.</p>"
},
"uri":{
"shape":"Uri",
"documentation":"<p> The uri of the component. </p>"
"documentation":"<p>The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either <code>data</code> or <code>uri</code> can be used to specify the data within the component. </p>"
},
"kmsKeyId":{
"shape":"NonEmptyString",
@ -2540,47 +2556,47 @@
"members":{
"arn":{
"shape":"ImageBuilderArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastruction configuration.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the infrastructure configuration.</p>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the infrastruction configuration.</p>"
"documentation":"<p>The name of the infrastructure configuration.</p>"
},
"description":{
"shape":"NonEmptyString",
"documentation":"<p>The description of the infrastruction configuration.</p>"
"documentation":"<p>The description of the infrastructure configuration.</p>"
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p>The instance types of the infrastruction configuration.</p>"
"documentation":"<p>The instance types of the infrastructure configuration.</p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
"documentation":"<p>The instance profile of the infrastruction configuration.</p>"
"documentation":"<p>The instance profile of the infrastructure configuration.</p>"
},
"securityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>The security group IDs of the infrastruction configuration.</p>"
"documentation":"<p>The security group IDs of the infrastructure configuration.</p>"
},
"subnetId":{
"shape":"NonEmptyString",
"documentation":"<p>The subnet ID of the infrastruction configuration.</p>"
"documentation":"<p>The subnet ID of the infrastructure configuration.</p>"
},
"logging":{
"shape":"Logging",
"documentation":"<p>The logging configuration of the infrastruction configuration.</p>"
"documentation":"<p>The logging configuration of the infrastructure configuration.</p>"
},
"keyPair":{
"shape":"NonEmptyString",
"documentation":"<p>The EC2 key pair of the infrastruction configuration.</p>"
"documentation":"<p>The EC2 key pair of the infrastructure configuration.</p>"
},
"terminateInstanceOnFailure":{
"shape":"NullableBoolean",
"documentation":"<p>The terminate instance on failure configuration of the infrastruction configuration.</p>"
"documentation":"<p>The terminate instance on failure configuration of the infrastructure configuration.</p>"
},
"snsTopicArn":{
"shape":"NonEmptyString",
"documentation":"<p>The SNS Topic Amazon Resource Name (ARN) of the infrastruction configuration.</p>"
"documentation":"<p>The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.</p>"
},
"dateCreated":{
"shape":"DateTime",
@ -2592,7 +2608,7 @@
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags of the infrastruction configuration.</p>"
"documentation":"<p>The tags of the infrastructure configuration.</p>"
}
},
"documentation":"<p>Details of the infrastructure configuration.</p>"
@ -2649,14 +2665,14 @@
},
"ebs":{
"shape":"EbsInstanceBlockDeviceSpecification",
"documentation":"<p>Use to manage EBS specific configuration for this mapping.</p>"
"documentation":"<p>Use to manage Amazon EBS-specific configuration for this mapping.</p>"
},
"virtualName":{
"shape":"NonEmptyString",
"documentation":"<p>Use to manage instance ephemeral devices.</p>"
},
"noDevice":{
"shape":"NonEmptyString",
"shape":"EmptyString",
"documentation":"<p>Use to remove a mapping from the parent image.</p>"
}
},
@ -2730,14 +2746,14 @@
"members":{
"userIds":{
"shape":"AccountList",
"documentation":"<p> </p>"
"documentation":"<p> The AWS account ID. </p>"
},
"userGroups":{
"shape":"StringList",
"documentation":"<p> </p>"
"documentation":"<p>The name of the group. </p>"
}
},
"documentation":"<p> </p>"
"documentation":"<p>Describes the configuration for a launch permission. The launch permission modification request is sent to the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">EC2 ModifyImageAttribute</a> API on behalf of the user for each Region they have selected to distribute the AMI.</p>"
},
"ListComponentBuildVersionsRequest":{
"type":"structure",
@ -2745,7 +2761,7 @@
"members":{
"componentVersionArn":{
"shape":"ComponentVersionArn",
"documentation":"<p> The component version arn whose versions you wish to list. </p>"
"documentation":"<p> The component version Amazon Resource Name (ARN) whose versions you want to list. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2771,7 +2787,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2780,11 +2796,11 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines whose components you wish to list. By default this request will only show components owned by your account. You may use this field to specify if you wish to view components owned by yourself, Amazon, or those components that have been shared with you by other customers. </p>"
"documentation":"<p> The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2810,7 +2826,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2819,7 +2835,7 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2845,7 +2861,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2855,11 +2871,11 @@
"members":{
"imageVersionArn":{
"shape":"ImageVersionArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose build versions you wish to retrieve. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2885,20 +2901,21 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
"ListImagePipelineImagesRequest":{
"type":"structure",
"required":["imagePipelineArn"],
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline whose images you wish to view. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline whose images you want to view. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2924,7 +2941,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2933,7 +2950,7 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2959,7 +2976,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -2968,11 +2985,11 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines whose image recipes you wish to list. By default this request will only show image recipes owned by your account. You may use this field to specify if you wish to view image recipes owned by yourself, Amazon, or those image recipes that have been shared with you by other customers. </p>"
"documentation":"<p> The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -2998,7 +3015,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -3007,11 +3024,11 @@
"members":{
"owner":{
"shape":"Ownership",
"documentation":"<p> The owner defines whose images you wish to list. By default this request will only show images owned by your account. You may use this field to specify if you wish to view images owned by yourself, Amazon, or those images that have been shared with you by other customers. </p>"
"documentation":"<p> The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers. </p>"
},
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -3037,7 +3054,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object. </p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects. </p>"
}
}
},
@ -3046,7 +3063,7 @@
"members":{
"filters":{
"shape":"FilterList",
"documentation":"<p> </p>"
"documentation":"<p> The filters. </p>"
},
"maxResults":{
"shape":"RestrictedInteger",
@ -3072,7 +3089,7 @@
},
"nextToken":{
"shape":"NonEmptyString",
"documentation":"<p> The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.</p>"
"documentation":"<p> The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.</p>"
}
}
},
@ -3082,7 +3099,7 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource whose tags you wish to retrieve. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve. </p>",
"location":"uri",
"locationName":"resourceArn"
}
@ -3102,10 +3119,10 @@
"members":{
"s3Logs":{
"shape":"S3Logs",
"documentation":"<p>The S3 logging configuration.</p>"
"documentation":"<p>The Amazon S3 logging configuration.</p>"
}
},
"documentation":"<p> Logging configuration defines where Image Builder uploads your logs to.</p>"
"documentation":"<p>Logging configuration defines where Image Builder uploads your logs.</p>"
},
"NonEmptyString":{
"type":"string",
@ -3118,10 +3135,10 @@
"members":{
"amis":{
"shape":"AmiList",
"documentation":"<p> The EC2 AMIs created by this image. </p>"
"documentation":"<p>The EC2 AMIs created by this image. </p>"
}
},
"documentation":"<p> The resources produced by this image. </p>"
"documentation":"<p>The resources produced by this image. </p>"
},
"Ownership":{
"type":"string",
@ -3256,7 +3273,7 @@
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>You have attempted to mutate or delete a resource with a dependency that is prohibitting this action. See the error message for more details.</p>",
"documentation":"<p>You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3265,7 +3282,7 @@
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The resource that you are trying to operate on is currently in use. Review the message details, and retry later.</p>",
"documentation":"<p>The resource that you are trying to operate on is currently in use. Review the message details and retry later.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -3292,25 +3309,25 @@
"members":{
"s3BucketName":{
"shape":"NonEmptyString",
"documentation":"<p>The S3 bucket in which to store the logs.</p>"
"documentation":"<p>The Amazon S3 bucket in which to store the logs.</p>"
},
"s3KeyPrefix":{
"shape":"NonEmptyString",
"documentation":"<p>The S3 path in which to store the logs.</p>"
"documentation":"<p>The Amazon S3 path in which to store the logs.</p>"
}
},
"documentation":"<p>S3 Logging configuration.</p>"
"documentation":"<p>Amazon S3 logging configuration.</p>"
},
"Schedule":{
"type":"structure",
"members":{
"scheduleExpression":{
"shape":"NonEmptyString",
"documentation":"<p> The expression determines how often a pipeline starts the creation of new images. </p>"
"documentation":"<p> The expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>.</p>"
},
"pipelineExecutionStartCondition":{
"shape":"PipelineExecutionStartCondition",
"documentation":"<p> The condition configures when the pipeline should trigger a new image build. </p>"
"documentation":"<p> The condition configures when the pipeline should trigger a new image build. When the <code>pipelineExecutionStartCondition</code> is set to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, EC2 Image Builder will build a new image only when there are known changes pending. When it is set to <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON expression matches the current time.</p>"
}
},
"documentation":"<p> A schedule configures how often and when a pipeline will automatically create a new image. </p>"
@ -3337,6 +3354,10 @@
"error":{"httpStatusCode":503},
"exception":true
},
"SnsTopicArn":{
"type":"string",
"pattern":"^arn:aws[^:]*:sns:[^:]+:\\d{12}:[a-zA-Z0-9-_]{1,256}$"
},
"StartImagePipelineExecutionRequest":{
"type":"structure",
"required":[
@ -3346,7 +3367,7 @@
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you wish to manually invoke. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke. </p>"
},
"clientToken":{
"shape":"ClientToken",
@ -3404,7 +3425,7 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you wish to tag. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you want to tag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
@ -3432,7 +3453,7 @@
"members":{
"resourceArn":{
"shape":"ImageBuilderArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you wish to untag. </p>",
"documentation":"<p> The Amazon Resource Name (ARN) of the resource that you want to untag. </p>",
"location":"uri",
"locationName":"resourceArn"
},
@ -3453,12 +3474,13 @@
"type":"structure",
"required":[
"distributionConfigurationArn",
"distributions",
"clientToken"
],
"members":{
"distributionConfigurationArn":{
"shape":"DistributionConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you wish to update. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the distribution configuration that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
@ -3496,12 +3518,14 @@
"type":"structure",
"required":[
"imagePipelineArn",
"imageRecipeArn",
"infrastructureConfigurationArn",
"clientToken"
],
"members":{
"imagePipelineArn":{
"shape":"ImagePipelineArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you wish to update. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the image pipeline that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
@ -3559,12 +3583,13 @@
"type":"structure",
"required":[
"infrastructureConfigurationArn",
"instanceProfileName",
"clientToken"
],
"members":{
"infrastructureConfigurationArn":{
"shape":"InfrastructureConfigurationArn",
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to update. </p>"
"documentation":"<p> The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update. </p>"
},
"description":{
"shape":"NonEmptyString",
@ -3572,7 +3597,7 @@
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p> The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability. </p>"
"documentation":"<p> The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability. </p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
@ -3592,14 +3617,14 @@
},
"keyPair":{
"shape":"NonEmptyString",
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image. </p>"
"documentation":"<p> The key pair of the infrastructure configuration. This can be used to log on to and debug the instance used to create your image. </p>"
},
"terminateInstanceOnFailure":{
"shape":"NullableBoolean",
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed. </p>"
"documentation":"<p> The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. </p>"
},
"snsTopicArn":{
"shape":"NonEmptyString",
"shape":"SnsTopicArn",
"documentation":"<p> The SNS topic on which to send image build events. </p>"
},
"clientToken":{
@ -3632,5 +3657,5 @@
"pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"
}
},
"documentation":"<p> Amazon Elastic Compute Cloud Image Builder provides a one-stop-shop to automate the image management processes. You configure an automated pipeline that creates images for use on AWS. As software updates become available, Image Builder automatically produces a new image based on a customizable schedule and distributes it to stipulated AWS Regions after running tests on it. With the Image Builder, organizations can capture their internal or industry-specific compliance policies as a vetted template that can be consistently applied to every new image. Built-in integration with AWS Organizations provides customers with a centralized way to enforce image distribution and access policies across their AWS accounts and Regions. Image Builder supports multiple image format AMIs on AWS.</p>"
"documentation":"<p>EC2 Image Builder is a fully managed AWS service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date “golden” server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.</p>"
}

View file

@ -4545,6 +4545,16 @@
},
"documentation":"<p>Configuration for the rollout of OTA updates.</p>"
},
"AwsJobPresignedUrlConfig":{
"type":"structure",
"members":{
"expiresInSec":{
"shape":"ExpiresInSeconds",
"documentation":"<p>How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.</p>"
}
},
"documentation":"<p>Configuration information for pre-signed URLs. Valid when <code>protocols</code> contains HTTP.</p>"
},
"Behavior":{
"type":"structure",
"required":["name"],
@ -5655,6 +5665,10 @@
"shape":"Targets",
"documentation":"<p>The targeted devices to receive OTA updates.</p>"
},
"protocols":{
"shape":"Protocols",
"documentation":"<p>The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.</p>"
@ -5663,6 +5677,10 @@
"shape":"AwsJobExecutionsRolloutConfig",
"documentation":"<p>Configuration for the rollout of OTA updates.</p>"
},
"awsJobPresignedUrlConfig":{
"shape":"AwsJobPresignedUrlConfig",
"documentation":"<p>Configuration information for pre-signed URLs.</p>"
},
"files":{
"shape":"OTAUpdateFiles",
"documentation":"<p>The files to be streamed by the OTA update.</p>"
@ -8254,6 +8272,7 @@
"max":3600,
"min":60
},
"ExpiresInSeconds":{"type":"long"},
"ExplicitDeny":{
"type":"structure",
"members":{
@ -11824,10 +11843,18 @@
"shape":"Targets",
"documentation":"<p>The targets of the OTA update.</p>"
},
"protocols":{
"shape":"Protocols",
"documentation":"<p>The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.</p>"
},
"awsJobExecutionsRolloutConfig":{
"shape":"AwsJobExecutionsRolloutConfig",
"documentation":"<p>Configuration for the rollout of OTA updates.</p>"
},
"awsJobPresignedUrlConfig":{
"shape":"AwsJobPresignedUrlConfig",
"documentation":"<p>Configuration information for pre-signed URLs. Valid when <code>protocols</code> contains HTTP.</p>"
},
"targetSelection":{
"shape":"TargetSelection",
"documentation":"<p>Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group. </p>"
@ -12102,6 +12129,19 @@
"type":"list",
"member":{"shape":"ProcessingTargetName"}
},
"Protocol":{
"type":"string",
"enum":[
"MQTT",
"HTTP"
]
},
"Protocols":{
"type":"list",
"member":{"shape":"Protocol"},
"max":2,
"min":1
},
"ProvisioningTemplateListing":{
"type":"list",
"member":{"shape":"ProvisioningTemplateSummary"}
@ -12188,11 +12228,11 @@
},
"assetId":{
"shape":"AssetId",
"documentation":"<p>The ID of the AWS IoT SiteWise asset. You must specify either a <code>propertyAlias</code> or both an <code>analiasId</code> and a <code>propertyId</code>. Accepts substitution templates.</p>"
"documentation":"<p>The ID of the AWS IoT SiteWise asset. You must specify either a <code>propertyAlias</code> or both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution templates.</p>"
},
"propertyId":{
"shape":"AssetPropertyId",
"documentation":"<p>The ID of the asset's property. You must specify either a <code>propertyAlias</code> or both an <code>analiasId</code> and a <code>propertyId</code>. Accepts substitution templates.</p>"
"documentation":"<p>The ID of the asset's property. You must specify either a <code>propertyAlias</code> or both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution templates.</p>"
},
"propertyAlias":{
"shape":"AssetPropertyAlias",
@ -13863,7 +13903,7 @@
},
"mqttContext":{
"shape":"MqttContext",
"documentation":"<p>Specifies a test MQTT authorization request.&gt;</p>"
"documentation":"<p>Specifies a test MQTT authorization request.</p>"
},
"tlsContext":{
"shape":"TlsContext",
@ -14232,7 +14272,7 @@
}
},
"documentation":"<p>The rate exceeds the limit.</p>",
"error":{"httpStatusCode":429},
"error":{"httpStatusCode":400},
"exception":true
},
"TimedOutThings":{"type":"integer"},

View file

@ -322,19 +322,19 @@
},
"lambda":{
"shape":"LambdaAction",
"documentation":"<p>Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.</p>"
"documentation":"<p>Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.</p>"
},
"iotEvents":{
"shape":"IotEventsAction",
"documentation":"<p>Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action.</p>"
"documentation":"<p>Sends an IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
},
"sqs":{
"shape":"SqsAction",
"documentation":"<p>Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.</p>"
},
"firehose":{
"shape":"FirehoseAction",
"documentation":"<p>Sends information about the detector model instance and the event which 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 a Kinesis Data Firehose delivery stream.</p>"
}
},
"documentation":"<p>An action to be performed when the <code>\"condition\"</code> is TRUE.</p>"
@ -408,7 +408,7 @@
},
"key":{
"shape":"AttributeJsonPath",
"documentation":"<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression 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 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>"
},
"roleArn":{
"shape":"AmazonResourceName",
@ -420,7 +420,7 @@
},
"evaluationMethod":{
"shape":"EvaluationMethod",
"documentation":"<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>"
"documentation":"<p>Information about the order in which events are evaluated and how actions are executed. </p>"
}
}
},
@ -636,11 +636,11 @@
},
"key":{
"shape":"AttributeJsonPath",
"documentation":"<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression 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 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>"
},
"evaluationMethod":{
"shape":"EvaluationMethod",
"documentation":"<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>"
"documentation":"<p>Information about the order in which events are evaluated and how actions are executed. </p>"
}
},
"documentation":"<p>Information about how the detector model is configured.</p>"
@ -749,7 +749,7 @@
},
"evaluationMethod":{
"shape":"EvaluationMethod",
"documentation":"<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>"
"documentation":"<p>Information about the order in which events are evaluated and how actions are executed. </p>"
}
},
"documentation":"<p>Information about the detector model version.</p>"
@ -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 which 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 a Kinesis Data Firehose delivery stream.</p>"
},
"FirehoseSeparator":{
"type":"string",
@ -957,7 +957,7 @@
"documentation":"<p>The name of the AWS IoT Events input where the data is sent.</p>"
}
},
"documentation":"<p>Sends an IoT Events input, passing in information about the detector model instance and the event which 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>"
},
"IotTopicPublishAction":{
"type":"structure",
@ -982,10 +982,10 @@
"members":{
"functionArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the AWS Lambda function which is executed.</p>"
"documentation":"<p>The ARN of the Lambda function that is executed.</p>"
}
},
"documentation":"<p>Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.</p>"
"documentation":"<p>Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.</p>"
},
"LimitExceededException":{
"type":"structure",
@ -1331,14 +1331,14 @@
"members":{
"queueUrl":{
"shape":"QueueUrl",
"documentation":"<p>The URL of the Amazon SQS queue where the data is written.</p>"
"documentation":"<p>The URL of the SQS queue where the data is written.</p>"
},
"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>Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.</p>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.</p>"
},
"State":{
"type":"structure",
@ -1549,7 +1549,7 @@
},
"evaluationMethod":{
"shape":"EvaluationMethod",
"documentation":"<p>When set to <code>SERIAL</code>, variables are updated and event conditions evaluated in the order that the events are defined. When set to <code>BATCH</code>, variables are updated and events performed only after all event conditions are evaluated.</p>"
"documentation":"<p>Information about the order in which events are evaluated and how actions are executed. </p>"
}
}
},

View file

@ -29,6 +29,12 @@
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Revisions"
},
"ListKafkaVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "KafkaVersions"
}
}
}

View file

@ -483,6 +483,39 @@
],
"documentation": "\n <p>Returns a list of all the MSK configurations in this Region.</p>\n "
},
"ListKafkaVersions": {
"name": "ListKafkaVersions",
"http": {
"method": "GET",
"requestUri": "/v1/kafka-versions",
"responseCode": 200
},
"input": {
"shape": "ListKafkaVersionsRequest"
},
"output": {
"shape": "ListKafkaVersionsResponse"
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "\n <p>The request isn't valid because the input is incorrect. Correct your input and then submit it again.</p>\n "
},
{
"shape": "UnauthorizedException",
"documentation": "\n <p>The request is not authorized. The provided credentials couldn't be validated.</p>\n "
},
{
"shape": "InternalServerErrorException",
"documentation": "\n <p>There was an unexpected internal server error. Retrying your request might resolve the issue.</p>\n "
},
{
"shape": "ForbiddenException",
"documentation": "\n <p>Access forbidden. Check your credentials and then retry your request.</p>\n "
}
],
"documentation": "\n <p>Returns a list of Kafka versions.</p>\n "
},
"ListNodes": {
"name": "ListNodes",
"http": {
@ -978,6 +1011,10 @@
"locationName": "state",
"documentation": "\n <p>The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.</p>\n "
},
"StateInfo" : {
"shape" : "StateInfo",
"locationName" : "stateInfo"
},
"Tags": {
"shape": "__mapOf__string",
"locationName": "tags",
@ -1653,6 +1690,26 @@
"httpStatusCode": 500
}
},
"KafkaVersion": {
"type": "structure",
"members": {
"Version": {
"shape": "__string",
"locationName": "version"
},
"Status": {
"shape": "KafkaVersionStatus",
"locationName": "status"
}
}
},
"KafkaVersionStatus": {
"type": "string",
"enum": [
"ACTIVE",
"DEPRECATED"
]
},
"ListClusterOperationsRequest": {
"type": "structure",
"members": {
@ -1805,6 +1862,36 @@
}
}
},
"ListKafkaVersionsRequest": {
"type": "structure",
"members": {
"MaxResults": {
"shape": "MaxResults",
"location": "querystring",
"locationName": "maxResults",
"documentation": "\n <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>"
},
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "nextToken",
"documentation": "\n <p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</p>"
}
}
},
"ListKafkaVersionsResponse": {
"type": "structure",
"members": {
"KafkaVersions": {
"shape": "__listOfKafkaVersion",
"locationName": "kafkaVersions"
},
"NextToken": {
"shape": "__string",
"locationName": "nextToken"
}
}
},
"ListNodesRequest": {
"type": "structure",
"members": {
@ -2093,6 +2180,19 @@
"httpStatusCode": 503
}
},
"StateInfo" : {
"type" : "structure",
"members" : {
"Code" : {
"shape" : "__string",
"locationName" : "code"
},
"Message" : {
"shape" : "__string",
"locationName" : "message"
}
}
},
"StorageInfo": {
"type": "structure",
"members": {
@ -2445,6 +2545,12 @@
"shape": "ConfigurationRevision"
}
},
"__listOfKafkaVersion": {
"type": "list",
"member": {
"shape": "KafkaVersion"
}
},
"__listOfNodeInfo": {
"type": "list",
"member": {
@ -2493,4 +2599,4 @@
}
},
"documentation": "\n <p>The operations for managing an Amazon MSK cluster.</p>\n "
}
}

View file

@ -2953,7 +2953,8 @@
"type":"string",
"enum":[
"SQL-1_0",
"FLINK-1_6"
"FLINK-1_6",
"FLINK-1_8"
]
},
"S3ApplicationCodeLocationDescription":{

View file

@ -45,7 +45,7 @@
{"shape":"KMSInternalException"},
{"shape":"CloudHsmClusterInvalidConfigurationException"}
],
"documentation":"<p>Connects or reconnects a <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">custom key store</a> to its associated AWS CloudHSM cluster.</p> <p>The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.</p> <p>To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html\">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html\">CreateHsm</a> operation.</p> <p>The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user</a> (CU), and rotates its password.</p> <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again.</p> <p>If you are having trouble connecting or disconnecting a custom key store, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Connects or reconnects a <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">custom key store</a> to its associated AWS CloudHSM cluster.</p> <p>The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.</p> <p>To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html\">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html\">CreateHsm</a> operation. Also, the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user</a> (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.</p> <p>The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p> <p>During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p> <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>.</p> <p>To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again.</p> <p>If you are having trouble connecting or disconnecting a custom key store, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateAlias":{
"name":"CreateAlias",
@ -124,7 +124,7 @@
{"shape":"CustomKeyStoreInvalidStateException"},
{"shape":"CloudHsmClusterInvalidConfigurationException"}
],
"documentation":"<p>Creates a unique customer managed <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys\">customer master key</a> (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.</p> <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric CMKs.</p> <ul> <li> <p> <b>Symmetric CMKs</b> contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys\">data keys</a> or data key pairs. For details, see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p> </li> <li> <p> <b>Asymmetric CMKs</b> can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To create different types of CMKs, use the following guidance:</p> <dl> <dt>Asymmetric CMKs</dt> <dd> <p>To create an asymmetric CMK, use the <code>CustomerMasterKeySpec</code> parameter to specify the type of key material in the CMK. Then, use the <code>KeyUsage</code> parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.</p> <p> </p> </dd> <dt>Symmetric CMKs</dt> <dd> <p>When creating a symmetric CMK, you don't need to specify the <code>CustomerMasterKeySpec</code> or <code>KeyUsage</code> parameters. The default value for <code>CustomerMasterKeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for symmetric CMKs. </p> <p> </p> </dd> <dt>Imported Key Material</dt> <dd> <p>To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt your key material. Then, use <a>ImportKeyMaterial</a> with your import token to import the key material. For step-by-step instructions, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>. You cannot import the key material into an asymmetric CMK.</p> <p> </p> </dd> <dt>Custom Key Stores</dt> <dd> <p>To create a symmetric CMK in a <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">custom key store</a>, use the <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. </p> <p>You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Using Custom Key Stores</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </dd> </dl>"
"documentation":"<p>Creates a unique customer managed <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys\">customer master key</a> (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.</p> <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric CMKs.</p> <ul> <li> <p> <b>Symmetric CMKs</b> contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys\">data keys</a> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs\">data keys pairs</a>. For details, see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p> </li> <li> <p> <b>Asymmetric CMKs</b> can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the <a>GetPublicKey</a> operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.</p> </li> </ul> <p>For information about symmetric and asymmetric CMKs, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To create different types of CMKs, use the following guidance:</p> <dl> <dt>Asymmetric CMKs</dt> <dd> <p>To create an asymmetric CMK, use the <code>CustomerMasterKeySpec</code> parameter to specify the type of key material in the CMK. Then, use the <code>KeyUsage</code> parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.</p> <p> </p> </dd> <dt>Symmetric CMKs</dt> <dd> <p>When creating a symmetric CMK, you don't need to specify the <code>CustomerMasterKeySpec</code> or <code>KeyUsage</code> parameters. The default value for <code>CustomerMasterKeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for symmetric CMKs. </p> <p> </p> </dd> <dt>Imported Key Material</dt> <dd> <p>To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code> with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt your key material. Then, use <a>ImportKeyMaterial</a> with your import token to import the key material. For step-by-step instructions, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>. You cannot import the key material into an asymmetric CMK.</p> <p> </p> </dd> <dt>Custom Key Stores</dt> <dd> <p>To create a symmetric CMK in a <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">custom key store</a>, use the <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region. </p> <p>You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Using Custom Key Stores</a> in the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </dd> </dl>"
},
"Decrypt":{
"name":"Decrypt",
@ -348,7 +348,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Generates a unique symmetric data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.</p> <p> <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.</p> <p>To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys.</p> <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p> <p>If the operation succeeds, the plaintext copy of the data key is in the <code>Plaintext</code> field of the response, and the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure random byte string, use <a>GenerateRandom</a>.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>We recommend that you use the following pattern to encrypt data locally in your application:</p> <ol> <li> <p>Use the <code>GenerateDataKey</code> operation to get a data encryption key.</p> </li> <li> <p>Use the plaintext data key (returned in the <code>Plaintext</code> field of the response) to encrypt data locally, then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (returned in the <code>CiphertextBlob</code> field of the response) alongside the locally encrypted data.</p> </li> </ol> <p>To decrypt data locally:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.</p> </li> </ol>"
"documentation":"<p>Generates a unique symmetric data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.</p> <p> <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.</p> <p>To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the <a>DescribeKey</a> operation.</p> <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p> <p>If the operation succeeds, the plaintext copy of the data key is in the <code>Plaintext</code> field of the response, and the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure random byte string, use <a>GenerateRandom</a>.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>We recommend that you use the following pattern to encrypt data locally in your application:</p> <ol> <li> <p>Use the <code>GenerateDataKey</code> operation to get a data encryption key.</p> </li> <li> <p>Use the plaintext data key (returned in the <code>Plaintext</code> field of the response) to encrypt data locally, then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (returned in the <code>CiphertextBlob</code> field of the response) alongside the locally encrypted data.</p> </li> </ol> <p>To decrypt data locally:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.</p> </li> </ol>"
},
"GenerateDataKeyPair":{
"name":"GenerateDataKeyPair",
@ -408,7 +408,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the <a>Decrypt</a> operation on the encrypted copy of the key. </p> <p>It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.</p> <p>To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the <code>KeySpec</code> field in the <a>DescribeKey</a> response. You must also specify the length of the data key using either the <code>KeySpec</code> or <code>NumberOfBytes</code> field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), use the <code>KeySpec</code> parameter. </p> <p>If the operation succeeds, you will find the plaintext copy of the data key in the <code>Plaintext</code> field of the response, and the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the <a>Decrypt</a> operation on the encrypted copy of the key. </p> <p>It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.</p> <p> <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.</p> <p>To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the <a>DescribeKey</a> operation.</p> <p>If the operation succeeds, you will find the encrypted copy of the data key in the <code>CiphertextBlob</code> field.</p> <p>You can use the optional encryption context to add additional security to the encryption operation. If you specify an <code>EncryptionContext</code>, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The CMK that you use for this operation must be in a compatible key state. For details, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"GenerateRandom":{
"name":"GenerateRandom",
@ -538,7 +538,7 @@
{"shape":"InvalidArnException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format <code>aws/&lt;service-name&gt;</code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit\">AWS KMS aliases limit</a>.</p>"
"documentation":"<p>Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format <code>aws/&lt;service-name&gt;</code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit\">AWS KMS aliases quota</a>.</p>"
},
"ListGrants":{
"name":"ListGrants",
@ -986,7 +986,10 @@
"NETWORK_ERRORS",
"INTERNAL_ERROR",
"INSUFFICIENT_CLOUDHSM_HSMS",
"USER_LOCKED_OUT"
"USER_LOCKED_OUT",
"USER_NOT_FOUND",
"USER_LOGGED_IN",
"SUBNET_NOT_FOUND"
]
},
"ConnectionStateType":{
@ -1039,7 +1042,7 @@
},
"KeyStorePassword":{
"shape":"KeyStorePasswordType",
"documentation":"<p>Enter the password of the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user (CU) account</a> in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.</p> <p>This parameter tells AWS KMS the <code>kmsuser</code> account password; it does not change the password in the AWS CloudHSM cluster.</p>"
"documentation":"<p>Enter the password of the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user (CU) account</a> in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.</p> <p>The password must be a string of 7 to 32 characters. Its value is case sensitive.</p> <p>This parameter tells AWS KMS the <code>kmsuser</code> account password; it does not change the password in the AWS CloudHSM cluster.</p>"
}
}
},
@ -1108,7 +1111,7 @@
"members":{
"Policy":{
"shape":"PolicyType",
"documentation":"<p>The key policy to attach to the CMK.</p> <p>If you provide a key policy, it must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>CreateKey</code> request to make a subsequent <a>PutKeyPolicy</a> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default Key Policy</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
"documentation":"<p>The key policy to attach to the CMK.</p> <p>If you provide a key policy, it must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>CreateKey</code> request to make a subsequent <a>PutKeyPolicy</a> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i> <i>AWS Key Management Service Developer Guide</i> </i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default Key Policy</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The key policy size quota is 32 kilobytes (32768 bytes).</p>"
},
"Description":{
"shape":"DescriptionType",
@ -1120,7 +1123,7 @@
},
"CustomerMasterKeySpec":{
"shape":"CustomerMasterKeySpec",
"documentation":"<p>Specifies the type of CMK to create. The <code>CustomerMasterKeySpec</code> determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the <code>CustomerMasterKeySpec</code> after the CMK is created. To further restrict the algorithms that can be used with the CMK, use its key policy or IAM policy.</p> <p>For help with choosing a key spec for your CMK, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#cmk-key-spec\">Selecting a Customer Master Key Spec</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The default value, <code>SYMMETRIC_DEFAULT</code>, creates a CMK with a 256-bit symmetric key.</p> <p>AWS KMS supports the following key specs for CMKs:</p> <ul> <li> <p>Symmetric key (default)</p> <ul> <li> <p> <code>SYMMETRIC_DEFAULT</code> (AES-256-GCM)</p> </li> </ul> </li> <li> <p>Asymmetric RSA key pairs</p> <ul> <li> <p> <code>RSA_2048</code> </p> </li> <li> <p> <code>RSA_3072</code> </p> </li> <li> <p> <code>RSA_4096</code> </p> </li> </ul> </li> <li> <p>Asymmetric NIST-recommended elliptic curve key pairs</p> <ul> <li> <p> <code>ECC_NIST_P256</code> (secp256r1)</p> </li> <li> <p> <code>ECC_NIST_P384</code> (secp384r1)</p> </li> <li> <p> <code>ECC_NIST_P521</code> (secp521r1)</p> </li> </ul> </li> <li> <p>Other asymmetric elliptic curve key pairs</p> <ul> <li> <p> <code>ECC_SECG_P256K1</code> (secp256k1), commonly used for cryptocurrencies.</p> </li> </ul> </li> </ul>"
"documentation":"<p>Specifies the type of CMK to create. The default value, <code>SYMMETRIC_DEFAULT</code>, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html\">How to Choose Your CMK Configuration</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The <code>CustomerMasterKeySpec</code> determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the <code>CustomerMasterKeySpec</code> after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm\">kms:EncryptionAlgorithm</a> or <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm\">kms:Signing Algorithm</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <important> <p> <a href=\"http://aws.amazon.com/kms/features/#AWS_Service_Integration\">AWS services that are integrated with AWS KMS</a> use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html\">Identifying Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </important> <p>AWS KMS supports the following key specs for CMKs:</p> <ul> <li> <p>Symmetric key (default)</p> <ul> <li> <p> <code>SYMMETRIC_DEFAULT</code> (AES-256-GCM)</p> </li> </ul> </li> <li> <p>Asymmetric RSA key pairs</p> <ul> <li> <p> <code>RSA_2048</code> </p> </li> <li> <p> <code>RSA_3072</code> </p> </li> <li> <p> <code>RSA_4096</code> </p> </li> </ul> </li> <li> <p>Asymmetric NIST-recommended elliptic curve key pairs</p> <ul> <li> <p> <code>ECC_NIST_P256</code> (secp256r1)</p> </li> <li> <p> <code>ECC_NIST_P384</code> (secp384r1)</p> </li> <li> <p> <code>ECC_NIST_P521</code> (secp521r1)</p> </li> </ul> </li> <li> <p>Other asymmetric elliptic curve key pairs</p> <ul> <li> <p> <code>ECC_SECG_P256K1</code> (secp256k1), commonly used for cryptocurrencies.</p> </li> </ul> </li> </ul>"
},
"Origin":{
"shape":"OriginType",
@ -1216,11 +1219,11 @@
},
"ConnectionState":{
"shape":"ConnectionStateType",
"documentation":"<p>Indicates whether the custom key store is connected to its AWS CloudHSM cluster.</p> <p>You can create and use CMKs in your custom key stores only when its connection state is <code>CONNECTED</code>.</p> <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.</p> <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. For help resolving a connection failure, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Indicates whether the custom key store is connected to its AWS CloudHSM cluster.</p> <p>You can create and use CMKs in your custom key stores only when its connection state is <code>CONNECTED</code>.</p> <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If the value is <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.</p> <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure. For help resolving a connection failure, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting a Custom Key Store</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"ConnectionErrorCode":{
"shape":"ConnectionErrorCodeType",
"documentation":"<p>Describes the connection error. Valid values are:</p> <ul> <li> <p> <code>CLUSTER_NOT_FOUND</code> - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.</p> </li> <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li> <li> <p> <code>INTERNAL_ERROR</code> - AWS KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li> <li> <p> <code>INVALID_CREDENTIALS</code> - AWS KMS does not have the correct password for the <code>kmsuser</code> crypto user in the AWS CloudHSM cluster.</p> </li> <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing AWS KMS from connecting to the custom key store.</p> </li> <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the password value for the custom key store.</p> </li> </ul> <p>For help with connection failures, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting Custom Key Stores</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Describes the connection error. This field appears in the response only when the <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed\">How to Fix a Connection Failure</a> in <i>AWS Key Management Service Developer Guide</i>.</p> <p>Valid values are:</p> <ul> <li> <p> <code>CLUSTER_NOT_FOUND</code> - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.</p> </li> <li> <p> <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.</p> </li> <li> <p> <code>INTERNAL_ERROR</code> - AWS KMS could not complete the request due to an internal error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the custom key store before trying to connect again.</p> </li> <li> <p> <code>INVALID_CREDENTIALS</code> - AWS KMS does not have the correct password for the <code>kmsuser</code> crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li> <li> <p> <code>NETWORK_ERRORS</code> - Network errors are preventing AWS KMS from connecting to the custom key store.</p> </li> <li> <p> <code>SUBNET_NOT_FOUND</code> - A subnet in the AWS CloudHSM cluster configuration was deleted. If AWS KMS cannot find all of the subnets that were configured for the cluster when the custom key store was created, attempts to connect fail. To fix this error, create a cluster from a backup and associate it with your custom key store. This process includes selecting a VPC and subnets. For details, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed\">How to Fix a Connection Failure</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p> <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the <code>kmsuser</code> account password and update the key store password value for the custom key store.</p> </li> <li> <p> <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the <code>kmsuser</code> account password and logging into the cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster. If you changed the <code>kmsuser</code> password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2\">How to Log Out and Reconnect</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p> <code>USER_NOT_FOUND</code> - AWS KMS cannot find a <code>kmsuser</code> CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update the key store password value for the custom key store.</p> </li> </ul>"
},
"CreationDate":{
"shape":"DateType",
@ -1622,7 +1625,7 @@
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. </p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the <a>DescribeKey</a> operation. </p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"KeyPairSpec":{
"shape":"DataKeyPairSpec",
@ -1647,7 +1650,7 @@
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. </p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the <a>DescribeKey</a> operation.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"KeyPairSpec":{
"shape":"DataKeyPairSpec",
@ -1870,7 +1873,7 @@
},
"PublicKey":{
"shape":"PublicKeyType",
"documentation":"<p>The exported public key. </p> <p>This value is returned as a binary <a href=\"https://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf\">Distinguished Encoding Rules</a> (DER)-encoded object. To decode it, use an ASN.1 parsing tool, such as <a href=\"https://www.openssl.org/docs/man1.0.2/man1/asn1parse.html\">OpenSSL asn1parse</a>.</p>"
"documentation":"<p>The exported public key. </p> <p>The value is a DER-encoded X.509 public key, also known as <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href=\"https://tools.ietf.org/html/rfc5280\">RFC 5280</a>. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p> <p/>"
},
"CustomerMasterKeySpec":{
"shape":"CustomerMasterKeySpec",
@ -2264,7 +2267,8 @@
},
"KeyStorePasswordType":{
"type":"string",
"min":1,
"max":32,
"min":7,
"sensitive":true
},
"KeyUnavailableException":{
@ -2288,7 +2292,7 @@
"members":{
"message":{"shape":"ErrorMessageType"}
},
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>",
"documentation":"<p>The request was rejected because a quota was exceeded. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>",
"exception":true
},
"LimitType":{
@ -2581,7 +2585,7 @@
},
"Policy":{
"shape":"PolicyType",
"documentation":"<p>The key policy to attach to the CMK.</p> <p>The key policy must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>PutKeyPolicy</code> request to make a subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
"documentation":"<p>The key policy to attach to the CMK.</p> <p>The key policy must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>PutKeyPolicy</code> request to make a subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html\">Resource Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"BypassPolicyLockoutSafetyCheck":{
"shape":"BooleanType",
@ -2734,7 +2738,7 @@
},
"MessageType":{
"shape":"MessageType",
"documentation":"<p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. To indicate a message, enter <code>RAW</code>. To indicate a message digest, enter <code>DIGEST</code>.</p>"
"documentation":"<p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter <code>DIGEST</code>.</p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
@ -2755,7 +2759,7 @@
},
"Signature":{
"shape":"CiphertextType",
"documentation":"<p>The cryptographic signature that was generated for the message.</p>"
"documentation":"<p>The cryptographic signature that was generated for the message. </p> <ul> <li> <p>When used with the supported RSA signing algorithms, the encoding of this value is defined by <a href=\"https://tools.ietf.org/html/rfc8017\">PKCS #1 in RFC 8017</a>.</p> </li> <li> <p>When used with the <code>ECDSA_SHA_256</code>, <code>ECDSA_SHA_384</code>, or <code>ECDSA_SHA_512</code> signing algorithms, this value is a DER-encoded object as defined by ANS X9.622005 and <a href=\"https://tools.ietf.org/html/rfc3279#section-2.2.3\">RFC 3279 Section 2.2.3</a>. This is the most commonly used signature format and is appropriate for most uses. </p> </li> </ul> <p>When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>"
},
"SigningAlgorithm":{
"shape":"SigningAlgorithmSpec",
@ -2948,11 +2952,11 @@
},
"Message":{
"shape":"PlaintextType",
"documentation":"<p>Specifies the message that was signed, or a hash digest of that message. Messages can be 0-4096 bytes. To verify a larger message, provide a hash digest of the message.</p> <p>If the digest of the message specified here is different from the message digest that was signed, the signature verification fails.</p>"
"documentation":"<p>Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the <code>MessageType</code> parameter with a value of <code>DIGEST</code>.</p> <p>If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.</p>"
},
"MessageType":{
"shape":"MessageType",
"documentation":"<p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. To indicate a message, enter <code>RAW</code>. To indicate a message digest, enter <code>DIGEST</code>.</p>"
"documentation":"<p>Tells AWS KMS whether the value of the <code>Message</code> parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter <code>DIGEST</code>.</p> <important> <p>Use the <code>DIGEST</code> value only when the value of the <code>Message</code> parameter is a message digest. If you use the <code>DIGEST</code> value with a raw message, the security of the verification operation can be compromised.</p> </important>"
},
"Signature":{
"shape":"CiphertextType",

View file

@ -84,7 +84,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.</p> <p>For details about each event source type, see the following topics.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html\">Using AWS Lambda with Amazon DynamoDB</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html\">Using AWS Lambda with Amazon Kinesis</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html\">Using AWS Lambda with Amazon SQS</a> </p> </li> </ul> <p>The following error handling options are only available for stream sources (DynamoDB and Kinesis):</p> <ul> <li> <p> <code>BisectBatchOnFunctionError</code> - If the function returns an error, split the batch in two and retry.</p> </li> <li> <p> <code>DestinationConfig</code> - Send discarded records to an Amazon SQS queue or Amazon SNS topic.</p> </li> <li> <p> <code>MaximumRecordAgeInSeconds</code> - Discard records older than the specified age.</p> </li> <li> <p> <code>MaximumRetryAttempts</code> - Discard records after the specified number of retries.</p> </li> </ul>"
"documentation":"<p>Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.</p> <p>For details about each event source type, see the following topics.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html\">Using AWS Lambda with Amazon DynamoDB</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html\">Using AWS Lambda with Amazon Kinesis</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html\">Using AWS Lambda with Amazon SQS</a> </p> </li> </ul> <p>The following error handling options are only available for stream sources (DynamoDB and Kinesis):</p> <ul> <li> <p> <code>BisectBatchOnFunctionError</code> - If the function returns an error, split the batch in two and retry.</p> </li> <li> <p> <code>DestinationConfig</code> - Send discarded records to an Amazon SQS queue or Amazon SNS topic.</p> </li> <li> <p> <code>MaximumRecordAgeInSeconds</code> - Discard records older than the specified age.</p> </li> <li> <p> <code>MaximumRetryAttempts</code> - Discard records after the specified number of retries.</p> </li> <li> <p> <code>ParallelizationFactor</code> - Process multiple batches from each shard concurrently.</p> </li> </ul>"
},
"CreateFunction":{
"name":"CreateFunction",
@ -763,7 +763,8 @@
{"shape":"ServiceException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"TooManyRequestsException"}
{"shape":"TooManyRequestsException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Adds <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/tagging.html\">tags</a> to a function.</p>"
},
@ -779,7 +780,8 @@
{"shape":"ServiceException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"TooManyRequestsException"}
{"shape":"TooManyRequestsException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Removes <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/tagging.html\">tags</a> from a function.</p>"
},
@ -819,7 +821,7 @@
{"shape":"ResourceConflictException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.</p> <p>The following error handling options are only available for stream sources (DynamoDB and Kinesis):</p> <ul> <li> <p> <code>BisectBatchOnFunctionError</code> - If the function returns an error, split the batch in two and retry.</p> </li> <li> <p> <code>DestinationConfig</code> - Send discarded records to an Amazon SQS queue or Amazon SNS topic.</p> </li> <li> <p> <code>MaximumRecordAgeInSeconds</code> - Discard records older than the specified age.</p> </li> <li> <p> <code>MaximumRetryAttempts</code> - Discard records after the specified number of retries.</p> </li> </ul>"
"documentation":"<p>Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.</p> <p>The following error handling options are only available for stream sources (DynamoDB and Kinesis):</p> <ul> <li> <p> <code>BisectBatchOnFunctionError</code> - If the function returns an error, split the batch in two and retry.</p> </li> <li> <p> <code>DestinationConfig</code> - Send discarded records to an Amazon SQS queue or Amazon SNS topic.</p> </li> <li> <p> <code>MaximumRecordAgeInSeconds</code> - Discard records older than the specified age.</p> </li> <li> <p> <code>MaximumRetryAttempts</code> - Discard records after the specified number of retries.</p> </li> <li> <p> <code>ParallelizationFactor</code> - Process multiple batches from each shard concurrently.</p> </li> </ul>"
},
"UpdateFunctionCode":{
"name":"UpdateFunctionCode",
@ -1785,7 +1787,7 @@
},
"LastUpdateStatus":{
"shape":"LastUpdateStatus",
"documentation":"<p>The status of the last update that was performed on the function.</p>"
"documentation":"<p>The status of the last update that was performed on the function. This is first set to <code>Successful</code> after function creation completes.</p>"
},
"LastUpdateStatusReason":{
"shape":"LastUpdateStatusReason",
@ -2303,7 +2305,7 @@
},
"FunctionError":{
"shape":"String",
"documentation":"<p>If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.</p> <ul> <li> <p> <code>Handled</code> - The runtime caught an error thrown by the function and formatted it into a JSON document.</p> </li> <li> <p> <code>Unhandled</code> - The runtime didn't handle the error. For example, the function ran out of memory or timed out.</p> </li> </ul>",
"documentation":"<p>If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.</p>",
"location":"header",
"locationName":"X-Amz-Function-Error"
},
@ -2426,7 +2428,10 @@
"EniLimitExceeded",
"InsufficientRolePermissions",
"InvalidConfiguration",
"InternalError"
"InternalError",
"SubnetOutOfIPAddresses",
"InvalidSubnet",
"InvalidSecurityGroup"
]
},
"Layer":{
@ -2705,7 +2710,7 @@
"members":{
"MasterRegion":{
"shape":"MasterRegion",
"documentation":"<p>For Lambda@Edge functions, the AWS Region of the master function. For example, <code>us-east-2</code> or <code>ALL</code>. If specified, you must set <code>FunctionVersion</code> to <code>ALL</code>.</p>",
"documentation":"<p>For Lambda@Edge functions, the AWS Region of the master function. For example, <code>us-east-1</code> filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set <code>FunctionVersion</code> to <code>ALL</code>.</p>",
"location":"querystring",
"locationName":"MasterRegion"
},
@ -3545,7 +3550,9 @@
"InsufficientRolePermissions",
"InvalidConfiguration",
"InternalError",
"SubnetOutOfIPAddresses"
"SubnetOutOfIPAddresses",
"InvalidSubnet",
"InvalidSecurityGroup"
]
},
"StatementId":{
@ -3641,7 +3648,7 @@
"documentation":"<p>The tracing mode.</p>"
}
},
"documentation":"<p>The function's AWS X-Ray tracing configuration.</p>"
"documentation":"<p>The function's AWS X-Ray tracing configuration. To sample and record incoming requests, set <code>Mode</code> to <code>Active</code>.</p>"
},
"TracingConfigResponse":{
"type":"structure",

View file

@ -689,6 +689,10 @@
"checksum":{
"shape":"String",
"documentation":"<p>Checksum of the bot alias.</p>"
},
"conversationLogs":{
"shape":"ConversationLogsResponse",
"documentation":"<p>Settings that determine how Amazon Lex uses conversation logs for the alias.</p>"
}
},
"documentation":"<p>Provides information about a bot alias.</p>"
@ -912,6 +916,38 @@
"CustomPayload"
]
},
"ConversationLogsRequest":{
"type":"structure",
"required":[
"logSettings",
"iamRoleArn"
],
"members":{
"logSettings":{
"shape":"LogSettingsRequestList",
"documentation":"<p>The settings for your conversation logs. You can log the conversation text, conversation audio, or both.</p>"
},
"iamRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html\">Creating an IAM Role and Policy for Conversation Logs</a>.</p>"
}
},
"documentation":"<p>Provides the settings needed for conversation logs.</p>"
},
"ConversationLogsResponse":{
"type":"structure",
"members":{
"logSettings":{
"shape":"LogSettingsResponseList",
"documentation":"<p>The settings for your conversation logs. You can log text, audio, or both.</p>"
},
"iamRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.</p>"
}
},
"documentation":"<p>Contains information about conversation log settings.</p>"
},
"Count":{"type":"integer"},
"CreateBotVersionRequest":{
"type":"structure",
@ -1129,6 +1165,14 @@
"valueSelectionStrategy":{
"shape":"SlotValueSelectionStrategy",
"documentation":"<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>"
},
"parentSlotTypeSignature":{
"shape":"CustomOrBuiltinSlotTypeName",
"documentation":"<p>The built-in slot type used a the parent of the slot type.</p>"
},
"slotTypeConfigurations":{
"shape":"SlotTypeConfigurations",
"documentation":"<p>Configuration information that extends the parent built-in slot type.</p>"
}
}
},
@ -1312,6 +1356,13 @@
"max":200,
"min":0
},
"Destination":{
"type":"string",
"enum":[
"CLOUDWATCH_LOGS",
"S3"
]
},
"EnumerationValue":{
"type":"structure",
"required":["value"],
@ -1331,7 +1382,7 @@
"type":"list",
"member":{"shape":"EnumerationValue"},
"max":10000,
"min":1
"min":0
},
"ExportStatus":{
"type":"string",
@ -1439,6 +1490,10 @@
"checksum":{
"shape":"String",
"documentation":"<p>Checksum of the bot alias.</p>"
},
"conversationLogs":{
"shape":"ConversationLogsResponse",
"documentation":"<p>The settings that determine how Amazon Lex uses conversation logs for the alias.</p>"
}
}
},
@ -2209,6 +2264,14 @@
"valueSelectionStrategy":{
"shape":"SlotValueSelectionStrategy",
"documentation":"<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>"
},
"parentSlotTypeSignature":{
"shape":"CustomOrBuiltinSlotTypeName",
"documentation":"<p>The built-in slot type used as a parent for the slot type.</p>"
},
"slotTypeConfigurations":{
"shape":"SlotTypeConfigurations",
"documentation":"<p>Configuration information that extends the parent built-in slot type.</p>"
}
}
},
@ -2332,6 +2395,12 @@
"max":5,
"min":1
},
"IamRoleArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"^arn:[\\w\\-]+:iam::[\\d]{12}:role\\/[\\w+=,\\.@\\-]{1,64}$"
},
"ImportStatus":{
"type":"string",
"enum":[
@ -2414,6 +2483,12 @@
"exception":true,
"fault":true
},
"KmsKeyArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$"
},
"LambdaARN":{
"type":"string",
"max":2048,
@ -2454,6 +2529,74 @@
"type":"list",
"member":{"shape":"Locale"}
},
"LogSettingsRequest":{
"type":"structure",
"required":[
"logType",
"destination",
"resourceArn"
],
"members":{
"logType":{
"shape":"LogType",
"documentation":"<p>The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.</p>"
},
"destination":{
"shape":"Destination",
"documentation":"<p>Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.</p>"
},
"kmsKeyArn":{
"shape":"KmsKeyArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.</p>"
},
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.</p>"
}
},
"documentation":"<p>Settings used to configure delivery mode and destination for conversation logs.</p>"
},
"LogSettingsRequestList":{
"type":"list",
"member":{"shape":"LogSettingsRequest"}
},
"LogSettingsResponse":{
"type":"structure",
"members":{
"logType":{
"shape":"LogType",
"documentation":"<p>The type of logging that is enabled.</p>"
},
"destination":{
"shape":"Destination",
"documentation":"<p>The destination where logs are delivered.</p>"
},
"kmsKeyArn":{
"shape":"KmsKeyArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.</p>"
},
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.</p>"
},
"resourcePrefix":{
"shape":"ResourcePrefix",
"documentation":"<p>The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified. </p>"
}
},
"documentation":"<p>The settings for conversation logs.</p>"
},
"LogSettingsResponseList":{
"type":"list",
"member":{"shape":"LogSettingsResponse"}
},
"LogType":{
"type":"string",
"enum":[
"AUDIO",
"TEXT"
]
},
"MaxResults":{
"type":"integer",
"box":true,
@ -2522,6 +2665,13 @@
"min":1,
"pattern":"[0-9]+"
},
"ObfuscationSetting":{
"type":"string",
"enum":[
"NONE",
"DEFAULT_OBFUSCATION"
]
},
"PreconditionFailedException":{
"type":"structure",
"members":{
@ -2601,6 +2751,10 @@
"checksum":{
"shape":"String",
"documentation":"<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new bot alias, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a bot alias, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>"
},
"conversationLogs":{
"shape":"ConversationLogsRequest",
"documentation":"<p>Settings for conversation logs for the alias.</p>"
}
}
},
@ -2634,6 +2788,10 @@
"checksum":{
"shape":"String",
"documentation":"<p>The checksum for the current version of the alias.</p>"
},
"conversationLogs":{
"shape":"ConversationLogsResponse",
"documentation":"<p>The settings that determine how Amazon Lex uses conversation logs for the alias.</p>"
}
}
},
@ -2932,6 +3090,14 @@
"createVersion":{
"shape":"Boolean",
"documentation":"<p>When set to <code>true</code> a new numbered version of the slot type is created. This is the same as calling the <code>CreateSlotTypeVersion</code> operation. If you do not specify <code>createVersion</code>, the default is <code>false</code>.</p>"
},
"parentSlotTypeSignature":{
"shape":"CustomOrBuiltinSlotTypeName",
"documentation":"<p>The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.</p> <p>Only <code>AMAZON.AlphaNumeric</code> is supported.</p>"
},
"slotTypeConfigurations":{
"shape":"SlotTypeConfigurations",
"documentation":"<p>Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.</p>"
}
}
},
@ -2973,6 +3139,14 @@
"createVersion":{
"shape":"Boolean",
"documentation":"<p> <code>True</code> if a new version of the slot type was created. If the <code>createVersion</code> field was not specified in the request, the <code>createVersion</code> field is set to false in the response.</p>"
},
"parentSlotTypeSignature":{
"shape":"CustomOrBuiltinSlotTypeName",
"documentation":"<p>The built-in slot type used as the parent of the slot type.</p>"
},
"slotTypeConfigurations":{
"shape":"SlotTypeConfigurations",
"documentation":"<p>Configuration information that extends the parent built-in slot type.</p>"
}
}
},
@ -2985,6 +3159,17 @@
"BotChannel"
]
},
"RegexPattern":{
"type":"string",
"max":100,
"min":1
},
"ResourceArn":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^arn:[\\w\\-]+:(?:logs:[\\w\\-]+:[\\d]{12}:log-group:[\\.\\-_/#A-Za-z0-9]{1,512}(?::\\*)?|s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9])$"
},
"ResourceInUseException":{
"type":"structure",
"members":{
@ -2995,6 +3180,10 @@
"error":{"httpStatusCode":400},
"exception":true
},
"ResourcePrefix":{
"type":"string",
"max":1024
},
"ResourceReference":{
"type":"structure",
"members":{
@ -3069,6 +3258,10 @@
"responseCard":{
"shape":"ResponseCard",
"documentation":"<p> A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply. </p>"
},
"obfuscationSetting":{
"shape":"ObfuscationSetting",
"documentation":"<p>Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is \"full_name\", obfuscated values are replaced with \"{full_name}\". For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html\"> Slot Obfuscation </a>. </p>"
}
},
"documentation":"<p>Identifies the version of a specific slot.</p>"
@ -3092,6 +3285,22 @@
"min":1,
"pattern":"^([A-Za-z](-|_|.)?)+$"
},
"SlotTypeConfiguration":{
"type":"structure",
"members":{
"regexConfiguration":{
"shape":"SlotTypeRegexConfiguration",
"documentation":"<p>A regular expression used to validate the value of a slot.</p>"
}
},
"documentation":"<p>Provides configuration information for a slot type.</p>"
},
"SlotTypeConfigurations":{
"type":"list",
"member":{"shape":"SlotTypeConfiguration"},
"max":10,
"min":0
},
"SlotTypeMetadata":{
"type":"structure",
"members":{
@ -3128,6 +3337,17 @@
"min":1,
"pattern":"^([A-Za-z]_?)+$"
},
"SlotTypeRegexConfiguration":{
"type":"structure",
"required":["pattern"],
"members":{
"pattern":{
"shape":"RegexPattern",
"documentation":"<p>A regular expression used to validate the value of a slot. </p> <p>Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:</p> <ul> <li> <p>A-Z, a-z</p> </li> <li> <p>0-9</p> </li> <li> <p>Unicode characters (\"\\ u&lt;Unicode&gt;\")</p> </li> </ul> <p>Represent Unicode characters with four digits, for example \"\\u0041\" or \"\\u005A\".</p> <p>The following regular expression operators are not supported:</p> <ul> <li> <p>Infinite repeaters: *, +, or {x,} with no upper bound.</p> </li> <li> <p>Wild card (.)</p> </li> </ul>"
}
},
"documentation":"<p>Provides a regular expression used to validate the value of a slot.</p>"
},
"SlotUtteranceList":{
"type":"list",
"member":{"shape":"Utterance"},

View file

@ -143,7 +143,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Copies a manual instance or disk snapshot as another manual snapshot, or copies an automatic instance or disk snapshot as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.</p> <p>When copying a <i>manual snapshot</i>, be sure to define the <code>source region</code>, <code>source snapshot name</code>, and <code>target snapshot name</code> parameters.</p> <p>When copying an <i>automatic snapshot</i>, be sure to define the <code>source region</code>, <code>source resource name</code>, <code>target snapshot name</code>, and either the <code>restore date</code> or the <code>use latest restorable auto snapshot</code> parameters.</p> <note> <p>Database snapshots cannot be copied at this time.</p> </note>"
"documentation":"<p>Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.</p> <p>When copying a <i>manual snapshot</i>, be sure to define the <code>source region</code>, <code>source snapshot name</code>, and <code>target snapshot name</code> parameters.</p> <p>When copying an <i>automatic snapshot</i>, be sure to define the <code>source region</code>, <code>source resource name</code>, <code>target snapshot name</code>, and either the <code>restore date</code> or the <code>use latest restorable auto snapshot</code> parameters.</p>"
},
"CreateCloudFormationStack":{
"name":"CreateCloudFormationStack",
@ -446,7 +446,7 @@
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes an automatic snapshot for an instance or disk.</p>"
"documentation":"<p>Deletes an automatic snapshot of an instance or disk. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
},
"DeleteDisk":{
"name":"DeleteDisk",
@ -842,7 +842,7 @@
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns the available automatic snapshots for the specified resource name. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Returns the available automatic snapshots for an instance or disk. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
},
"GetBlueprints":{
"name":"GetBlueprints",
@ -2001,7 +2001,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Allows the update of one or more parameters of a database in Amazon Lightsail.</p> <p>Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: <code>dynamic</code> or <code>pending-reboot</code>. Parameters marked with a <code>dynamic</code> apply type are applied immediately. Parameters marked with a <code>pending-reboot</code> apply type are applied only after the database is rebooted using the <code>reboot relational database</code> operation.</p> <p>The <code>update relational database parameters</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Allows the update of one or more parameters of a database in Amazon Lightsail.</p> <p>Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: <code>dynamic</code> or <code>pending-reboot</code>. Parameters marked with a <code>dynamic</code> apply type are applied immediately. Parameters marked with a <code>pending-reboot</code> apply type are applied only after the database is rebooted using the <code>reboot relational database</code> operation.</p> <p>The <code>update relational database parameters</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
}
},
"shapes":{
@ -2524,23 +2524,23 @@
"members":{
"sourceSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source instance or disk snapshot to be copied.</p> <note> <p>Define this parameter only when copying a manual snapshot as another manual snapshot.</p> </note>"
"documentation":"<p>The name of the source manual snapshot to copy.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying a manual snapshot as another manual snapshot.</p> </li> </ul>"
},
"sourceResourceName":{
"shape":"string",
"documentation":"<p>The name of the source resource from which the automatic snapshot was created.</p> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The name of the source instance or disk from which the source automatic snapshot was created.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to copy for the new manual snapshot.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The date of the source automatic snapshot to copy. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"targetSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the new instance or disk snapshot to be created as a copy.</p>"
"documentation":"<p>The name of the new manual snapshot to be created as a copy.</p>"
},
"sourceRegion":{
"shape":"RegionName",
@ -2590,7 +2590,7 @@
},
"diskSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p> <p>This parameter cannot be defined together with the <code>source disk name</code> parameter. The <code>disk snapshot name</code> and <code>source disk name</code> parameters are mutually exclusive.</p>"
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p> <p>Constraint:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>source disk name</code> parameter. The <code>disk snapshot name</code> and <code>source disk name</code> parameters are mutually exclusive.</p> </li> </ul>"
},
"availabilityZone":{
"shape":"NonEmptyString",
@ -2610,15 +2610,15 @@
},
"sourceDiskName":{
"shape":"string",
"documentation":"<p>The name of the source disk from which the source automatic snapshot was created.</p> <p>This parameter cannot be defined together with the <code>disk snapshot name</code> parameter. The <code>source disk name</code> and <code>disk snapshot name</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The name of the source disk from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>disk snapshot name</code> parameter. The <code>source disk name</code> and <code>disk snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to use for the new disk.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The date of the automatic snapshot to use for the new disk. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
}
}
},
@ -2802,7 +2802,7 @@
},
"instanceSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.</p> <p>This parameter cannot be defined together with the <code>source instance name</code> parameter. The <code>instance snapshot name</code> and <code>source instance name</code> parameters are mutually exclusive.</p>"
"documentation":"<p>The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.</p> <p>Constraint:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>source instance name</code> parameter. The <code>instance snapshot name</code> and <code>source instance name</code> parameters are mutually exclusive.</p> </li> </ul>"
},
"bundleId":{
"shape":"NonEmptyString",
@ -2826,15 +2826,15 @@
},
"sourceInstanceName":{
"shape":"string",
"documentation":"<p>The name of the source instance from which the source automatic snapshot was created.</p> <p>This parameter cannot be defined together with the <code>instance snapshot name</code> parameter. The <code>source instance name</code> and <code>instance snapshot name</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The name of the source instance from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>instance snapshot name</code> parameter. The <code>source instance name</code> and <code>instance snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to use for the new instance.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>The date of the automatic snapshot to use for the new instance. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </li> </ul>"
}
}
},
@ -3179,11 +3179,11 @@
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to delete the automatic snapshot.</p>"
"documentation":"<p>The name of the source instance or disk from which to delete the automatic snapshot.</p>"
},
"date":{
"shape":"AutoSnapshotDate",
"documentation":"<p>The date of the automatic snapshot to delete in <code>YYYY-MM-DD</code> format.</p> <p>Use the <code>get auto snapshots</code> operation to get the available automatic snapshots for a resource.</p>"
"documentation":"<p>The date of the automatic snapshot to delete in <code>YYYY-MM-DD</code> format. Use the <code>get auto snapshots</code> operation to get the available automatic snapshots for a resource.</p>"
}
}
},
@ -3549,7 +3549,7 @@
},
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to disable the add-on.</p>"
"documentation":"<p>The name of the source resource for which to disable the add-on.</p>"
}
}
},
@ -4052,7 +4052,7 @@
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to get automatic snapshot information.</p>"
"documentation":"<p>The name of the source instance or disk from which to get automatic snapshot information.</p>"
}
}
},
@ -4061,7 +4061,7 @@
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource for the automatic snapshots.</p>"
"documentation":"<p>The name of the source instance or disk for the automatic snapshots.</p>"
},
"resourceType":{
"shape":"ResourceType",
@ -4069,7 +4069,7 @@
},
"autoSnapshots":{
"shape":"AutoSnapshotDetailsList",
"documentation":"<p>An array of objects that describe the automatic snapshots that are available for the specified source resource.asdf</p>"
"documentation":"<p>An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.</p>"
}
}
},
@ -6729,6 +6729,10 @@
"pendingMaintenanceActions":{
"shape":"PendingMaintenanceActionList",
"documentation":"<p>Describes the pending maintenance actions for the database.</p>"
},
"caCertificateIdentifier":{
"shape":"string",
"documentation":"<p>The certificate associated with the database.</p>"
}
},
"documentation":"<p>Describes a database.</p>"
@ -7464,6 +7468,10 @@
"applyImmediately":{
"shape":"boolean",
"documentation":"<p>When <code>true</code>, applies changes immediately. When <code>false</code>, applies changes during the preferred maintenance window. Some changes may cause an outage.</p> <p>Default: <code>false</code> </p>"
},
"caCertificateIdentifier":{
"shape":"string",
"documentation":"<p>Indicates the certificate that needs to be associated with the database.</p>"
}
}
},

View file

@ -25,7 +25,7 @@
{"shape":"OperationAbortedException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.</p> <p>Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>Note that it can take up to 5 minutes for this operation to take effect.</p> <p>If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p>"
"documentation":"<p>Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.</p> <p>Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <note> <p> <b>Important:</b> CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p> </note> <p>Note that it can take up to 5 minutes for this operation to take effect.</p> <p>If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p>"
},
"CancelExportTask":{
"name":"CancelExportTask",
@ -74,7 +74,7 @@
{"shape":"OperationAbortedException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates a log group with the specified name.</p> <p>You can create up to 20,000 log groups per account.</p> <p>You must use the following guidelines when naming a log group:</p> <ul> <li> <p>Log group names must be unique within a region for an AWS account.</p> </li> <li> <p>Log group names can be between 1 and 512 characters long.</p> </li> <li> <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)</p> </li> </ul> <p>If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p>"
"documentation":"<p>Creates a log group with the specified name.</p> <p>You can create up to 20,000 log groups per account.</p> <p>You must use the following guidelines when naming a log group:</p> <ul> <li> <p>Log group names must be unique within a region for an AWS account.</p> </li> <li> <p>Log group names can be between 1 and 512 characters long.</p> </li> <li> <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number sign)</p> </li> </ul> <p>If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p> <note> <p> <b>Important:</b> CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p> </note>"
},
"CreateLogStream":{
"name":"CreateLogStream",
@ -89,7 +89,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates a log stream for the specified log group.</p> <p>There is no limit on the number of log streams that you can create for a log group.</p> <p>You must use the following guidelines when naming a log stream:</p> <ul> <li> <p>Log stream names must be unique within the log group.</p> </li> <li> <p>Log stream names can be between 1 and 512 characters long.</p> </li> <li> <p>The ':' (colon) and '*' (asterisk) characters are not allowed.</p> </li> </ul>"
"documentation":"<p>Creates a log stream for the specified log group.</p> <p>There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on <code>CreateLogStream</code> operations, after which transactions are throttled.</p> <p>You must use the following guidelines when naming a log stream:</p> <ul> <li> <p>Log stream names must be unique within the log group.</p> </li> <li> <p>Log stream names can be between 1 and 512 characters long.</p> </li> <li> <p>The ':' (colon) and '*' (asterisk) characters are not allowed.</p> </li> </ul>"
},
"DeleteDestination":{
"name":"DeleteDestination",
@ -462,7 +462,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"UnrecognizedClientException"}
],
"documentation":"<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or older than the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) </p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> </ul> <p>If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key. </p>"
"documentation":"<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token in the <code>expectedSequenceToken</code> field from <code>InvalidSequenceTokenException</code>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or older than the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) </p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.</p> </li> </ul> <p>If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key. </p>"
},
"PutMetricFilter":{
"name":"PutMetricFilter",
@ -617,7 +617,7 @@
},
"kmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a> and <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p>"
}
}
},
@ -1530,7 +1530,7 @@
"members":{
"expectedSequenceToken":{"shape":"SequenceToken"}
},
"documentation":"<p>The sequence token is not valid.</p>",
"documentation":"<p>The sequence token is not valid. You can get the correct sequence token in the <code>expectedSequenceToken</code> field in the <code>InvalidSequenceTokenException</code> message. </p>",
"exception":true
},
"KmsKeyId":{

View file

@ -101,7 +101,7 @@
"members":{
"dataSetType":{
"shape":"DataSetType",
"documentation":"<p>The desired data set type.</p> <p> <ul> <li> <strong>customer_subscriber_hourly_monthly_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>customer_subscriber_annual_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_usage_by_instance_type</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_fees</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_free_trial_conversions</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_instances</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_canceled_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_billing_and_revenue_data</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.</p> </li> <li> <strong>monthly_revenue_annual_subscriptions</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>monthly_revenue_field_demonstration_usage</strong> <p>From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_flexible_payment_schedule</strong> <p>From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_product</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_product_with_uncollected_funds</strong> <p>From 2012-04-19 to 2015-01-25: Available every 30 days by 24:00 UTC.</p> <p>From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.</p> </li> <li> <strong>disbursed_amount_by_instance_hours</strong> <p>From 2012-09-04 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_customer_geo</strong> <p>From 2012-04-19 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_uncollected_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_disbursed_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_past_due_funds</strong> <p>From 2018-04-07 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_uncollected_funds_breakdown</strong> <p>From 2019-10-04 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>customer_profile_by_industry</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_revenue</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_geography</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>sales_compensation_billed_revenue</strong> <p>From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-06 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>us_sales_and_use_tax_records</strong> <p>From 2017-02-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> </ul> </p>"
"documentation":"<p>The desired data set type.</p> <p> <ul> <li> <strong>customer_subscriber_hourly_monthly_subscriptions</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>customer_subscriber_annual_subscriptions</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_usage_by_instance_type</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_fees</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_free_trial_conversions</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_instances</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_product_subscribers</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_canceled_product_subscribers</strong> <p>From 2017-09-15 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_billing_and_revenue_data</strong> <p>From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.</p> </li> <li> <strong>monthly_revenue_annual_subscriptions</strong> <p>From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>monthly_revenue_field_demonstration_usage</strong> <p>From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_flexible_payment_schedule</strong> <p>From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_product</strong> <p>From 2017-09-15 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_instance_hours</strong> <p>From 2017-09-15 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_customer_geo</strong> <p>From 2017-09-15 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_uncollected_funds</strong> <p>From 2017-09-15 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_disbursed_funds</strong> <p>From 2017-09-15 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_past_due_funds</strong> <p>From 2018-04-07 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_uncollected_funds_breakdown</strong> <p>From 2019-10-04 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>sales_compensation_billed_revenue</strong> <p>From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>us_sales_and_use_tax_records</strong> <p>From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> </ul> </p>"
},
"dataSetPublicationDate":{
"shape":"DataSetPublicationDate",

View file

@ -1311,7 +1311,7 @@
},
"AlphaBehavior": {
"type": "string",
"documentation": "Ignore this setting unless this input is a QuickTime animation. Specify which part of this input MediaConvert uses for your outputs. Leave this setting set to DISCARD in order to delete the alpha channel and preserve the video. Use REMAP_TO_LUMA for this setting to delete the video and map the alpha channel to the luma channel of your outputs.",
"documentation": "Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete the video and map the alpha channel to the luma channel of your outputs.",
"enum": [
"DISCARD",
"REMAP_TO_LUMA"
@ -1386,6 +1386,7 @@
"enum": [
"AAC",
"MP2",
"MP3",
"WAV",
"AIFF",
"AC3",
@ -1432,13 +1433,18 @@
"locationName": "mp2Settings",
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2."
},
"Mp3Settings": {
"shape": "Mp3Settings",
"locationName": "mp3Settings",
"documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3."
},
"WavSettings": {
"shape": "WavSettings",
"locationName": "wavSettings",
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV."
}
},
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings"
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings"
},
"AudioDefaultSelection": {
"type": "string",
@ -1474,7 +1480,7 @@
"CodecSettings": {
"shape": "AudioCodecSettings",
"locationName": "codecSettings",
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings"
"documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings"
},
"CustomLanguageCode": {
"shape": "__stringPatternAZaZ23AZaZ",
@ -1562,7 +1568,7 @@
"CorrectionGateLevel": {
"shape": "__integerMinNegative70Max0",
"locationName": "correctionGateLevel",
"documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction."
"documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected."
},
"LoudnessLogging": {
"shape": "AudioNormalizationLoudnessLogging",
@ -1596,7 +1602,7 @@
"documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio."
},
"ExternalAudioFileInput": {
"shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
"shape": "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
"locationName": "externalAudioFileInput",
"documentation": "Specifies audio data from an external file source."
},
@ -1670,7 +1676,7 @@
"type": "structure",
"members": {
"AvailBlankingImage": {
"shape": "__stringMin14PatternHttpHttpsS3BmpBMPPngPNG",
"shape": "__stringMin14PatternS3BmpBMPPngPNGHttpsBmpBMPPngPNG",
"locationName": "availBlankingImage",
"documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported."
}
@ -2249,6 +2255,11 @@
"shape": "CmafWriteHLSManifest",
"locationName": "writeHlsManifest",
"documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output."
},
"WriteSegmentTimelineInRepresentation": {
"shape": "CmafWriteSegmentTimelineInRepresentation",
"locationName": "writeSegmentTimelineInRepresentation",
"documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element."
}
},
"documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output."
@ -2325,6 +2336,46 @@
"ENABLED"
]
},
"CmafWriteSegmentTimelineInRepresentation": {
"type": "string",
"documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.",
"enum": [
"ENABLED",
"DISABLED"
]
},
"CmfcScte35Esam": {
"type": "string",
"documentation": "Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).",
"enum": [
"INSERT",
"NONE"
]
},
"CmfcScte35Source": {
"type": "string",
"documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output.",
"enum": [
"PASSTHROUGH",
"NONE"
]
},
"CmfcSettings": {
"type": "structure",
"members": {
"Scte35Esam": {
"shape": "CmfcScte35Esam",
"locationName": "scte35Esam",
"documentation": "Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml)."
},
"Scte35Source": {
"shape": "CmfcScte35Source",
"locationName": "scte35Source",
"documentation": "Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want those SCTE-35 markers in this output."
}
},
"documentation": "Settings for MP4 segments in CMAF"
},
"ColorCorrector": {
"type": "structure",
"members": {
@ -2423,6 +2474,11 @@
"ContainerSettings": {
"type": "structure",
"members": {
"CmfcSettings": {
"shape": "CmfcSettings",
"locationName": "cmfcSettings",
"documentation": "Settings for MP4 segments in CMAF"
},
"Container": {
"shape": "ContainerType",
"locationName": "container",
@ -3900,7 +3956,7 @@
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708."
},
"SourceFile": {
"shape": "__stringMin14PatternHttpHttpsS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
"shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
"locationName": "sourceFile",
"documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'."
},
@ -4207,7 +4263,12 @@
"QvbrQualityLevel": {
"shape": "__integerMin1Max10",
"locationName": "qvbrQualityLevel",
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the 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."
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. 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 H.264 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."
@ -4629,7 +4690,12 @@
"QvbrQualityLevel": {
"shape": "__integerMin1Max10",
"locationName": "qvbrQualityLevel",
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the 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."
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. 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 H.265 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."
@ -5376,7 +5442,7 @@
"SegmentModifier": {
"shape": "__string",
"locationName": "segmentModifier",
"documentation": "String concatenated to end of segment filenames. Accepts \"Format Identifiers\":#format_identifier_parameters."
"documentation": "Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html"
}
},
"documentation": "Settings for HLS output groups"
@ -5483,7 +5549,7 @@
"documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs."
},
"FileInput": {
"shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL",
"shape": "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL",
"locationName": "fileInput",
"documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL."
},
@ -5750,7 +5816,7 @@
"documentation": "Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank."
},
"ImageInserterInput": {
"shape": "__stringMin14PatternHttpHttpsS3BmpBMPPngPNGTgaTGA",
"shape": "__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA",
"locationName": "imageInserterInput",
"documentation": "Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file."
},
@ -6974,7 +7040,7 @@
"documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video."
},
"Input": {
"shape": "__stringMin14Max1285PatternHttpHttpsS3Mov09Png",
"shape": "__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png",
"locationName": "input",
"documentation": "Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence."
},
@ -7141,6 +7207,45 @@
},
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2."
},
"Mp3RateControlMode": {
"type": "string",
"documentation": "Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR).",
"enum": [
"CBR",
"VBR"
]
},
"Mp3Settings": {
"type": "structure",
"members": {
"Bitrate": {
"shape": "__integerMin16000Max320000",
"locationName": "bitrate",
"documentation": "Specify the average bitrate in bits per second."
},
"Channels": {
"shape": "__integerMin1Max2",
"locationName": "channels",
"documentation": "Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In the API, valid values are 1 and 2."
},
"RateControlMode": {
"shape": "Mp3RateControlMode",
"locationName": "rateControlMode",
"documentation": "Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate (VBR)."
},
"SampleRate": {
"shape": "__integerMin22050Max48000",
"locationName": "sampleRate",
"documentation": "Sample rate in hz."
},
"VbrQuality": {
"shape": "__integerMin0Max9",
"locationName": "vbrQuality",
"documentation": "Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the audio quality of this MP3 output from 0 (highest quality) to 9 (lowest quality)."
}
},
"documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3."
},
"Mp4CslgAtom": {
"type": "string",
"documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.",
@ -7173,6 +7278,11 @@
"locationName": "cslgAtom",
"documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools."
},
"CttsVersion": {
"shape": "__integerMin0Max1",
"locationName": "cttsVersion",
"documentation": "Ignore this setting unless compliance to the CTTS box version specification matters in your workflow. Specify a value of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you specify a value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set your CTTS box version to 0. This can provide backward compatibility for some players and packagers."
},
"FreeSpaceBox": {
"shape": "Mp4FreeSpaceBox",
"locationName": "freeSpaceBox",
@ -9024,7 +9134,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. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings"
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value 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"
},
"VideoDescription": {
"type": "structure",
@ -9042,7 +9152,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. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings"
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value 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"
},
"ColorMetadata": {
"shape": "ColorMetadata",
@ -9165,7 +9275,7 @@
"AlphaBehavior": {
"shape": "AlphaBehavior",
"locationName": "alphaBehavior",
"documentation": "Ignore this setting unless this input is a QuickTime animation. Specify which part of this input MediaConvert uses for your outputs. Leave this setting set to DISCARD in order to delete the alpha channel and preserve the video. Use REMAP_TO_LUMA for this setting to delete the video and map the alpha channel to the luma channel of your outputs."
"documentation": "Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA to delete the video and map the alpha channel to the luma channel of your outputs."
},
"ColorSpace": {
"shape": "ColorSpace",
@ -9251,6 +9361,9 @@
"__doubleMin0": {
"type": "double"
},
"__doubleMin0Max1": {
"type": "double"
},
"__doubleMin0Max2147483647": {
"type": "double"
},
@ -9274,6 +9387,11 @@
"min": 0,
"max": 0
},
"__integerMin0Max1": {
"type": "integer",
"min": 0,
"max": 1
},
"__integerMin0Max10": {
"type": "integer",
"min": 0,
@ -9384,6 +9502,11 @@
"min": 0,
"max": 8
},
"__integerMin0Max9": {
"type": "integer",
"min": 0,
"max": 9
},
"__integerMin0Max96": {
"type": "integer",
"min": 0,
@ -9424,6 +9547,11 @@
"min": 10,
"max": 48
},
"__integerMin16000Max320000": {
"type": "integer",
"min": 16000,
"max": 320000
},
"__integerMin16Max24": {
"type": "integer",
"min": 16,
@ -9504,6 +9632,11 @@
"min": 1,
"max": 64
},
"__integerMin22050Max48000": {
"type": "integer",
"min": 22050,
"max": 48000
},
"__integerMin24Max60000": {
"type": "integer",
"min": 24,
@ -9875,26 +10008,26 @@
"max": 11,
"pattern": "^((([0-1]\\d)|(2[0-3]))(:[0-5]\\d){2}([:;][0-5]\\d))$"
},
"__stringMin14Max1285PatternHttpHttpsS3Mov09Png": {
"__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png": {
"type": "string",
"min": 14,
"max": 1285,
"pattern": "^(http|https|s3)://(.*)(\\.mov|[0-9]+\\.png)$"
"pattern": "^((s3://(.*)(\\.mov|[0-9]+\\.png))|(https?://(.*)(\\.mov|[0-9]+\\.png)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternHttpHttpsS3BmpBMPPngPNG": {
"__stringMin14PatternS3BmpBMPPngPNGHttpsBmpBMPPngPNG": {
"type": "string",
"min": 14,
"pattern": "^(http|https|s3)://(.*?)\\.(bmp|BMP|png|PNG)$"
"pattern": "^((s3://(.*?)\\.(bmp|BMP|png|PNG))|(https?://(.*?)\\.(bmp|BMP|png|PNG)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternHttpHttpsS3BmpBMPPngPNGTgaTGA": {
"__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA": {
"type": "string",
"min": 14,
"pattern": "^(http|https|s3)://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)$"
"pattern": "^((s3://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA))|(https?://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternHttpHttpsS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI": {
"__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI": {
"type": "string",
"min": 14,
"pattern": "^(http|https|s3)://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI)$"
"pattern": "^((s3://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI))|(https?://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin16Max24PatternAZaZ0922AZaZ0916": {
"type": "string",
@ -9987,14 +10120,6 @@
"type": "string",
"pattern": "^(\\d+(\\/\\d+)*)$"
},
"__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
"type": "string",
"pattern": "^(http|https|s3)://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$"
},
"__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": {
"type": "string",
"pattern": "^(http|https|s3)://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$"
},
"__stringPatternHttps": {
"type": "string",
"pattern": "^https:\\/\\/"
@ -10011,6 +10136,14 @@
"type": "string",
"pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$"
},
"__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
"type": "string",
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": {
"type": "string",
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringPatternSNManifestConfirmConditionNotificationNS": {
"type": "string",
"pattern": "^\\s*<(.|\\n)*ManifestConfirmConditionNotification(.|\\n)*>\\s*$"

View file

@ -2463,6 +2463,14 @@
},
"documentation": "Audio Normalization Settings"
},
"AudioOnlyHlsSegmentType": {
"type": "string",
"documentation": "Audio Only Hls Segment Type",
"enum": [
"AAC",
"FMP4"
]
},
"AudioOnlyHlsSettings": {
"type": "structure",
"members": {
@ -2480,6 +2488,11 @@
"shape": "AudioOnlyHlsTrackType",
"locationName": "audioTrackType",
"documentation": "Four types of audio-only tracks are supported:\n\nAudio-Only Variant Stream\nThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.\n\nAlternate Audio, Auto Select, Default\nAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES\n\nAlternate Audio, Auto Select, Not Default\nAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES\n\nAlternate Audio, not Auto Select\nAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO"
},
"SegmentType": {
"shape": "AudioOnlyHlsSegmentType",
"locationName": "segmentType",
"documentation": "Specifies the segment type."
}
},
"documentation": "Audio Only Hls Settings"
@ -5473,6 +5486,17 @@
"Time"
]
},
"Fmp4HlsSettings": {
"type": "structure",
"members": {
"AudioRenditionSets": {
"shape": "__string",
"locationName": "audioRenditionSets",
"documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','."
}
},
"documentation": "Fmp4 Hls Settings"
},
"FollowModeScheduleActionStartSettings": {
"type": "structure",
"members": {
@ -5529,6 +5553,14 @@
"Destination"
]
},
"FrameCaptureIntervalUnit": {
"type": "string",
"documentation": "Frame Capture Interval Unit",
"enum": [
"MILLISECONDS",
"SECONDS"
]
},
"FrameCaptureOutputSettings": {
"type": "structure",
"members": {
@ -5547,6 +5579,11 @@
"shape": "__integerMin1Max3600000",
"locationName": "captureInterval",
"documentation": "The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits."
},
"CaptureIntervalUnits": {
"shape": "FrameCaptureIntervalUnit",
"locationName": "captureIntervalUnits",
"documentation": "Unit for the frame capture interval."
}
},
"documentation": "Frame Capture Settings",
@ -5938,7 +5975,7 @@
"RateControlMode": {
"shape": "H264RateControlMode",
"locationName": "rateControlMode",
"documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates."
"documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates.\n\nMultiplex: This rate control mode is only supported (and is required) when the video is being\ndelivered to a MediaLive Multiplex in which case the rate control configuration is controlled\nby the properties within the Multiplex Program."
},
"ScanType": {
"shape": "H264ScanType",
@ -6497,11 +6534,21 @@
"locationName": "baseUrlContent",
"documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
},
"BaseUrlContent1": {
"shape": "__string",
"locationName": "baseUrlContent1",
"documentation": "Optional. One value per output group.\n\nThis field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0."
},
"BaseUrlManifest": {
"shape": "__string",
"locationName": "baseUrlManifest",
"documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file."
},
"BaseUrlManifest1": {
"shape": "__string",
"locationName": "baseUrlManifest1",
"documentation": "Optional. One value per output group.\n\nComplete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0."
},
"CaptionLanguageMappings": {
"shape": "__listOfCaptionLanguageMapping",
"locationName": "captionLanguageMappings",
@ -6547,6 +6594,11 @@
"locationName": "hlsCdnSettings",
"documentation": "Parameters that control interactions with the CDN."
},
"HlsId3SegmentTagging": {
"shape": "HlsId3SegmentTaggingState",
"locationName": "hlsId3SegmentTagging",
"documentation": "State of HLS ID3 Segment Tagging"
},
"IFrameOnlyPlaylists": {
"shape": "IFrameOnlyPlaylistType",
"locationName": "iFrameOnlyPlaylists",
@ -6678,6 +6730,36 @@
"Destination"
]
},
"HlsH265PackagingType": {
"type": "string",
"documentation": "Hls H265 Packaging Type",
"enum": [
"HEV1",
"HVC1"
]
},
"HlsId3SegmentTaggingScheduleActionSettings": {
"type": "structure",
"members": {
"Tag": {
"shape": "__string",
"locationName": "tag",
"documentation": "ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related values.\\nSupported keyword identifiers: https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html"
}
},
"documentation": "Settings for the action to insert a user-defined ID3 tag in each HLS segment",
"required": [
"Tag"
]
},
"HlsId3SegmentTaggingState": {
"type": "string",
"documentation": "State of HLS ID3 Segment Tagging",
"enum": [
"DISABLED",
"ENABLED"
]
},
"HlsInputSettings": {
"type": "structure",
"members": {
@ -6793,6 +6875,11 @@
"HlsOutputSettings": {
"type": "structure",
"members": {
"H265PackagingType": {
"shape": "HlsH265PackagingType",
"locationName": "h265PackagingType",
"documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
},
"HlsSettings": {
"shape": "HlsSettings",
"locationName": "hlsSettings",
@ -6845,6 +6932,10 @@
"shape": "AudioOnlyHlsSettings",
"locationName": "audioOnlyHlsSettings"
},
"Fmp4HlsSettings": {
"shape": "Fmp4HlsSettings",
"locationName": "fmp4HlsSettings"
},
"StandardHlsSettings": {
"shape": "StandardHlsSettings",
"locationName": "standardHlsSettings"
@ -10175,6 +10266,11 @@
"ScheduleActionSettings": {
"type": "structure",
"members": {
"HlsId3SegmentTaggingSettings": {
"shape": "HlsId3SegmentTaggingScheduleActionSettings",
"locationName": "hlsId3SegmentTaggingSettings",
"documentation": "Action to insert HLS ID3 segment tagging"
},
"HlsTimedMetadataSettings": {
"shape": "HlsTimedMetadataScheduleActionSettings",
"locationName": "hlsTimedMetadataSettings",
@ -11309,11 +11405,10 @@
"members": {
"Message": {
"shape": "__string",
"locationName": "message",
"documentation": "The error message."
"locationName": "message"
},
"ValidationErrors": {
"shape": "__listOfMultiplexValidationError",
"shape": "__listOfValidationError",
"locationName": "validationErrors",
"documentation": "A collection of validation error responses."
}

View file

@ -622,6 +622,26 @@
],
"type": "string"
},
"Authorization": {
"documentation": "CDN Authorization credentials",
"members": {
"CdnIdentifierSecret": {
"documentation": "The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN) uses for authorization to access your endpoint.\n",
"locationName": "cdnIdentifierSecret",
"shape": "__string"
},
"SecretsRoleArn": {
"documentation": "The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.\n",
"locationName": "secretsRoleArn",
"shape": "__string"
}
},
"required": [
"SecretsRoleArn",
"CdnIdentifierSecret"
],
"type": "structure"
},
"Channel": {
"documentation": "A Channel resource configuration.",
"members": {
@ -917,6 +937,10 @@
"CreateOriginEndpointRequest": {
"documentation": "Configuration parameters used to create a new OriginEndpoint.",
"members": {
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.\n",
"locationName": "channelId",
@ -991,6 +1015,10 @@
"locationName": "arn",
"shape": "__string"
},
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel the OriginEndpoint is associated with.",
"locationName": "channelId",
@ -1306,6 +1334,10 @@
"locationName": "arn",
"shape": "__string"
},
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel the OriginEndpoint is associated with.",
"locationName": "channelId",
@ -1947,6 +1979,10 @@
"locationName": "arn",
"shape": "__string"
},
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel the OriginEndpoint is associated with.",
"locationName": "channelId",
@ -2018,6 +2054,10 @@
"OriginEndpointCreateParameters": {
"documentation": "Configuration parameters for a new OriginEndpoint.",
"members": {
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.\n",
"locationName": "channelId",
@ -2080,8 +2120,8 @@
}
},
"required": [
"Id",
"ChannelId"
"ChannelId",
"Id"
],
"type": "structure"
},
@ -2104,6 +2144,10 @@
"OriginEndpointUpdateParameters": {
"documentation": "Configuration parameters for updating an existing OriginEndpoint.",
"members": {
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"CmafPackage": {
"locationName": "cmafPackage",
"shape": "CmafPackageCreateOrUpdateParameters"
@ -2529,6 +2573,10 @@
"UpdateOriginEndpointRequest": {
"documentation": "Configuration parameters used to update an existing OriginEndpoint.",
"members": {
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"CmafPackage": {
"locationName": "cmafPackage",
"shape": "CmafPackageCreateOrUpdateParameters"
@ -2594,6 +2642,10 @@
"locationName": "arn",
"shape": "__string"
},
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"ChannelId": {
"documentation": "The ID of the Channel the OriginEndpoint is associated with.",
"locationName": "channelId",
@ -2754,4 +2806,4 @@
"type": "string"
}
}
}
}

View file

@ -23,6 +23,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ProgressUpdateStreamSummaryList"
},
"ListApplicationStates": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ApplicationStateList"
}
}
}

View file

@ -189,6 +189,23 @@
],
"documentation":"<p>Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.</p> <p>This API is a prerequisite to calling the <code>NotifyMigrationTaskState</code> API as the migration tool must first register the migration task with Migration Hub.</p>"
},
"ListApplicationStates":{
"name":"ListApplicationStates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListApplicationStatesRequest"},
"output":{"shape":"ListApplicationStatesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"HomeRegionNotSetException"}
],
"documentation":"<p>Lists all the migration statuses for your applications. If you use the optional <code>ApplicationIds</code> parameter, only the migration statuses for those applications will be returned.</p>"
},
"ListCreatedArtifacts":{
"name":"ListCreatedArtifacts",
"http":{
@ -337,6 +354,36 @@
"max":1600,
"min":1
},
"ApplicationIds":{
"type":"list",
"member":{"shape":"ApplicationId"},
"max":100,
"min":1
},
"ApplicationState":{
"type":"structure",
"members":{
"ApplicationId":{
"shape":"ApplicationId",
"documentation":"<p>The configurationId from the Application Discovery Service that uniquely identifies an application.</p>"
},
"ApplicationStatus":{
"shape":"ApplicationStatus",
"documentation":"<p>The current status of an application.</p>"
},
"LastUpdatedTime":{
"shape":"UpdateDateTime",
"documentation":"<p>The timestamp when the application status was last updated.</p>"
}
},
"documentation":"<p>The state of an application discovered through Migration Hub import, the AWS Agentless Discovery Connector, or the AWS Application Discovery Agent.</p>"
},
"ApplicationStateList":{
"type":"list",
"member":{"shape":"ApplicationState"},
"max":1000,
"min":0
},
"ApplicationStatus":{
"type":"string",
"enum":[
@ -681,6 +728,36 @@
"max":100,
"min":0
},
"ListApplicationStatesRequest":{
"type":"structure",
"members":{
"ApplicationIds":{
"shape":"ApplicationIds",
"documentation":"<p>The configurationIds from the Application Discovery Service that uniquely identifies your applications.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Maximum number of results to be returned per page.</p>"
}
}
},
"ListApplicationStatesResult":{
"type":"structure",
"members":{
"ApplicationStateList":{
"shape":"ApplicationStateList",
"documentation":"<p>A list of Applications that exist in Application Discovery Service.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>"
}
}
},
"ListCreatedArtifactsRequest":{
"type":"structure",
"required":[

View file

@ -753,6 +753,16 @@
"locationName" : "hostInstanceType",
"documentation" : "The type of broker instance."
},
"StorageType" : {
"shape" : "BrokerStorageType",
"locationName" : "storageType",
"documentation" : "The broker's storage type."
},
"SupportedDeploymentModes" : {
"shape" : "__listOfDeploymentMode",
"locationName" : "supportedDeploymentModes",
"documentation" : "The list of supported deployment modes."
},
"SupportedEngineVersions" : {
"shape" : "__listOf__string",
"locationName" : "supportedEngineVersions",
@ -787,6 +797,11 @@
"documentation" : "The status of the broker.",
"enum" : [ "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS" ]
},
"BrokerStorageType" : {
"type" : "string",
"documentation" : "The storage type of the broker.",
"enum" : [ "EBS", "EFS" ]
},
"BrokerSummary" : {
"type" : "structure",
"members" : {
@ -1029,7 +1044,12 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
},
"StorageType" : {
"shape" : "BrokerStorageType",
"locationName" : "storageType",
"documentation" : "The broker's storage type."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1047,7 +1067,7 @@
"documentation" : "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
}
},
"documentation" : "Required. The time period during which Amazon MQ applies pending updates or patches to the broker."
"documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"CreateBrokerOutput" : {
"type" : "structure",
@ -1132,7 +1152,12 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
},
"StorageType" : {
"shape" : "BrokerStorageType",
"locationName" : "storageType",
"documentation" : "The broker's storage type."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1508,6 +1533,12 @@
"location" : "querystring",
"locationName" : "nextToken",
"documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty."
},
"StorageType" : {
"shape" : "__string",
"location" : "querystring",
"locationName" : "storageType",
"documentation" : "Filter response by storage type."
}
}
},
@ -1614,16 +1645,16 @@
"locationName" : "pendingEngineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PendingHostInstanceType" : {
"shape" : "__string",
"locationName" : "pendingHostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PubliclyAccessible" : {
"shape" : "__boolean",
"locationName" : "publiclyAccessible",
@ -1632,7 +1663,12 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
},
"StorageType" : {
"shape" : "BrokerStorageType",
"locationName" : "storageType",
"documentation" : "The broker's storage type."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1747,16 +1783,16 @@
"locationName" : "pendingEngineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PendingHostInstanceType" : {
"shape" : "__string",
"locationName" : "pendingHostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PubliclyAccessible" : {
"shape" : "__boolean",
"locationName" : "publiclyAccessible",
@ -1765,7 +1801,12 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
},
"StorageType" : {
"shape" : "BrokerStorageType",
"locationName" : "storageType",
"documentation" : "The broker's storage type."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -2553,7 +2594,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
}
},
"documentation" : "Updates the broker using the specified properties."
@ -2594,7 +2635,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
}
},
"documentation" : "Returns information about the updated broker."
@ -2636,7 +2677,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
}
},
"documentation" : "Updates the broker using the specified properties.",
@ -2678,7 +2719,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers."
}
}
},
@ -2997,6 +3038,12 @@
"shape" : "ConfigurationRevision"
}
},
"__listOfDeploymentMode" : {
"type" : "list",
"member" : {
"shape" : "DeploymentMode"
}
},
"__listOfEngineVersion" : {
"type" : "list",
"member" : {
@ -3062,4 +3109,4 @@
}
},
"documentation" : "Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols."
}
}

View file

@ -1269,7 +1269,7 @@
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified KMS encryption key.</p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.</p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>.</p> <p> KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</p>"
"documentation":"<p>The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.</p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>.</p> <p> KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</p> <p>You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.</p>"
},
"PreSignedUrl":{
"shape":"String",
@ -1340,7 +1340,7 @@
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified CharacterSet.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"DatabaseName":{
"shape":"String",
@ -1368,7 +1368,7 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p> <p>Example: <code>1.0.1</code> </p>"
"documentation":"<p>The version number of the database engine to use. Currently, setting this parameter has no effect.</p> <p>Example: <code>1.0.1</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
@ -1384,7 +1384,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified option group.</p> <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -1421,6 +1421,10 @@
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>"
},
"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>"
}
}
},
@ -1567,7 +1571,7 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p>"
"documentation":"<p>The version number of the database engine to use. Currently, setting this parameter has no effect.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@ -1583,11 +1587,11 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>Indicates that the DB instance should be associated with the specified option group.</p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>Indicates that the DB instance should be associated with the specified CharacterSet.</p> <p>Not applicable. The character set is managed by the DB cluster. For more information, see <a>CreateDBCluster</a>.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
@ -1656,15 +1660,19 @@
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
"documentation":"<p>True to enable Performance Insights for the DB instance, and otherwise false.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>"
},
"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>"
}
}
},
@ -1798,7 +1806,7 @@
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>If present, specifies the name of the character set that this cluster is associated with.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"DatabaseName":{
"shape":"String",
@ -1862,7 +1870,7 @@
},
"DBClusterOptionGroupMemberships":{
"shape":"DBClusterOptionGroupMemberships",
"documentation":"<p>Provides the list of option group memberships for this DB cluster.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -1927,6 +1935,10 @@
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB cluster is configured to export to CloudWatch Logs.</p>"
},
"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>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>",
@ -2365,11 +2377,11 @@
},
"DefaultCharacterSet":{
"shape":"CharacterSet",
"documentation":"<p> The default character set for new instances of this engine version, if the <code>CharacterSetName</code> parameter of the CreateDBInstance API is not specified.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"SupportedCharacterSets":{
"shape":"SupportedCharacterSetsList",
"documentation":"<p> A list of the character sets supported by this engine for the <code>CharacterSetName</code> parameter of the <code>CreateDBInstance</code> action.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"ValidUpgradeTarget":{
"shape":"ValidUpgradeTargetList",
@ -2527,11 +2539,11 @@
},
"OptionGroupMemberships":{
"shape":"OptionGroupMembershipList",
"documentation":"<p>Provides the list of option group memberships for this DB instance.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"CharacterSetName":{
"shape":"String",
"documentation":"<p>If present, specifies the name of the character set that this instance is associated with.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"SecondaryAvailabilityZone":{
"shape":"String",
@ -2616,15 +2628,19 @@
},
"PerformanceInsightsEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>True if Performance Insights is enabled for the DB instance, and otherwise false.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>"
},
"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>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>",
@ -4164,7 +4180,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.</p> <p>Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -4184,7 +4200,11 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.</p> <p>For a list of valid engine versions, see <a>CreateDBInstance</a>, or call <a>DescribeDBEngineVersions</a>.</p>"
"documentation":"<p>The version number of the database engine. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the <a>ApplyPendingMaintenanceAction</a> API.</p> <p>For a list of valid engine versions, see <a>CreateDBInstance</a>, or call <a>DescribeDBEngineVersions</a>.</p>"
},
"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>"
}
}
},
@ -4300,11 +4320,11 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p> The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request.</p> <p>For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.</p>"
"documentation":"<p>The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the <a>ApplyPendingMaintenanceAction</a> API.</p>"
},
"AllowMajorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.</p> <p>Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.</p>"
"documentation":"<p>Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@ -4320,7 +4340,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p> Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the <code>ApplyImmediately</code> parameter is set to <code>true</code> for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.</p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"NewDBInstanceIdentifier":{
"shape":"String",
@ -4381,15 +4401,19 @@
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
"documentation":"<p>Not supported.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"PerformanceInsightsKMSKeyId":{
"shape":"String",
"documentation":"<p>Not supported.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"CloudwatchLogsExportConfiguration":{
"shape":"CloudwatchLogsExportConfiguration",
"documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.</p>"
},
"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>"
}
}
},
@ -4565,7 +4589,7 @@
},
"SupportsPerformanceInsights":{
"shape":"Boolean",
"documentation":"<p>True if a DB instance supports Performance Insights, otherwise false.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"MinStorageSize":{
"shape":"IntegerOptional",
@ -4796,7 +4820,7 @@
},
"PendingCloudwatchLogsExports":{
"shape":"PendingCloudwatchLogsExports",
"documentation":"<p>Specifies the CloudWatch logs to be exported.</p>"
"documentation":"<p>This <code>PendingCloudwatchLogsExports</code> structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.</p>"
}
},
"documentation":"<p> This data type is used as a response element in the <a>ModifyDBInstance</a> action.</p>"
@ -5057,7 +5081,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>The name of the option group to use for the restored DB cluster.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
@ -5082,6 +5106,10 @@
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to associate with the new DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"
},
"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>"
}
}
},
@ -5128,7 +5156,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>The name of the option group for the new DB cluster.</p>"
"documentation":"<p> <i>(Not supported by Neptune)</i> </p>"
},
"VpcSecurityGroupIds":{
"shape":"VpcSecurityGroupIdList",
@ -5153,6 +5181,10 @@
"DBClusterParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB cluster parameter group to associate with the new DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>"
},
"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>"
}
}
},

View file

@ -190,6 +190,20 @@
],
"documentation":"<p> Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server. </p> <p> This operation is synchronous. </p> <p> A <code>ValidationException</code> is raised when parameters of the request are not valid. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. An <code>InvalidStateException</code> is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or backups.</p>"
},
"RestoreServer":{
"name":"RestoreServer",
"http":{
@ -203,7 +217,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p> Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. </p> <p> This operation is asynchronous. </p> <p> An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>"
"documentation":"<p> Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. </p> <p>Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a <code>HEALTHY</code> state, AWS OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a <code>Running</code> or <code>Stopped</code> state, but is eventually terminated.</p> <p> This operation is asynchronous. </p> <p> An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>"
},
"StartMaintenance":{
"name":"StartMaintenance",
@ -220,6 +234,36 @@
],
"documentation":"<p> Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an <code>UNDER_MAINTENANCE</code> state while maintenance is in progress. </p> <p> Maintenance can only be started on servers in <code>HEALTHY</code> and <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server, or to server backups.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Removes specified tags from an AWS OpsWorks-CM server or backup.</p>"
},
"UpdateServer":{
"name":"UpdateServer",
"http":{
@ -252,6 +296,10 @@
}
},
"shapes":{
"AWSOpsWorksCMResourceArn":{
"type":"string",
"pattern":"arn:aws.*:opsworks-cm:.*:[0-9]{12}:.*"
},
"AccountAttribute":{
"type":"structure",
"members":{
@ -462,6 +510,10 @@
"Description":{
"shape":"String",
"documentation":"<p> A user-defined description of the backup. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.</p> <ul> <li> <p>The key cannot be empty.</p> </li> <li> <p>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>Leading and trailing white spaces are trimmed from both the key and value.</p> </li> <li> <p>A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.</p> </li> </ul>"
}
}
},
@ -489,15 +541,15 @@
},
"CustomDomain":{
"shape":"CustomDomain",
"documentation":"<p>An optional public endpoint of a server, such as <code>https://aws.my-company.com</code>. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated <code>Endpoint</code> value if the server is using a custom domain. If you specify a custom domain, you must also specify values for <code>CustomCertificate</code> and <code>CustomPrivateKey</code>.</p>"
"documentation":"<p>Supported on servers running Chef Automate 2. An optional public endpoint of a server, such as <code>https://aws.my-company.com</code>. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated <code>Endpoint</code> value if the server is using a custom domain. If you specify a custom domain, you must also specify values for <code>CustomCertificate</code> and <code>CustomPrivateKey</code>.</p>"
},
"CustomCertificate":{
"shape":"CustomCertificate",
"documentation":"<p>A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for <code>CustomDomain</code> and <code>CustomPrivateKey</code>. The following are requirements for the <code>CustomCertificate</code> value:</p> <ul> <li> <p>You can provide either a self-signed, custom certificate, or the full certificate chain.</p> </li> <li> <p>The certificate must be a valid X509 certificate, or a certificate chain in PEM format.</p> </li> <li> <p>The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's <code>NotBefore</code> date), or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> <li> <p>The certificates common name or subject alternative names (SANs), if present, must match the value of <code>CustomDomain</code>.</p> </li> <li> <p>The certificate must match the value of <code>CustomPrivateKey</code>.</p> </li> </ul>"
"documentation":"<p>Supported on servers running Chef Automate 2. A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for <code>CustomDomain</code> and <code>CustomPrivateKey</code>. The following are requirements for the <code>CustomCertificate</code> value:</p> <ul> <li> <p>You can provide either a self-signed, custom certificate, or the full certificate chain.</p> </li> <li> <p>The certificate must be a valid X509 certificate, or a certificate chain in PEM format.</p> </li> <li> <p>The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's <code>NotBefore</code> date), or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> <li> <p>The certificates common name or subject alternative names (SANs), if present, must match the value of <code>CustomDomain</code>.</p> </li> <li> <p>The certificate must match the value of <code>CustomPrivateKey</code>.</p> </li> </ul>"
},
"CustomPrivateKey":{
"shape":"CustomPrivateKey",
"documentation":"<p>A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for <code>CustomDomain</code> and <code>CustomCertificate</code>.</p>"
"documentation":"<p>Supported on servers running Chef Automate 2. A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for <code>CustomDomain</code> and <code>CustomCertificate</code>.</p>"
},
"DisableAutomatedBackup":{
"shape":"Boolean",
@ -559,6 +611,10 @@
"shape":"Strings",
"documentation":"<p> The IDs of subnets in which to launch the server EC2 instance. </p> <p> Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled. </p> <p> EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled. </p> <p>For more information about supported Amazon EC2 platforms, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server.</p> <ul> <li> <p>The key cannot be empty.</p> </li> <li> <p>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>Leading and trailing white spaces are trimmed from both the key and value.</p> </li> <li> <p>A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.</p> </li> </ul>"
},
"BackupId":{
"shape":"BackupId",
"documentation":"<p> If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId. </p>"
@ -751,7 +807,7 @@
"members":{
"Servers":{
"shape":"Servers",
"documentation":"<p>Contains the response to a <code>DescribeServers</code> request.</p> <p> <i>For Puppet Server:</i> <code>DescribeServersResponse$Servers$EngineAttributes</code> contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.</p>"
"documentation":"<p>Contains the response to a <code>DescribeServers</code> request.</p> <p> <i>For Chef Automate servers:</i> If <code>DescribeServersResponse$Servers$EngineAttributes</code> includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.</p> <p> <i>For Puppet Server:</i> <code>DescribeServersResponse$Servers$EngineAttributes</code> contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.</p>"
},
"NextToken":{
"shape":"String",
@ -896,6 +952,37 @@
"documentation":"<p>The limit of servers or backups has been reached. </p>",
"exception":true
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"AWSOpsWorksCMResourceArn",
"documentation":"<p>The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, <code>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>ListTagsForResource</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>Tags that have been applied to the resource.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token that you can use as the value of <code>NextToken</code> in subsequent calls to the API to show more results.</p>"
}
}
},
"MaintenanceStatus":{
"type":"string",
"enum":[
@ -971,7 +1058,7 @@
},
"InstanceType":{
"shape":"String",
"documentation":"<p> The type of the instance to create. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m5.large</code>. Valid values are <code>m5.large</code>, <code>r5.xlarge</code>, and <code>r5.2xlarge</code>. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. </p>"
"documentation":"<p> The type of instance to restore. Valid values must be specified in the following format: <code>^([cm][34]|t2).*</code> For example, <code>m5.large</code>. Valid values are <code>m5.large</code>, <code>r5.xlarge</code>, and <code>r5.2xlarge</code>. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup. </p>"
},
"KeyPair":{
"shape":"KeyPair",
@ -1155,7 +1242,7 @@
},
"EngineAttributes":{
"shape":"EngineAttributes",
"documentation":"<p>Engine attributes that are specific to the server on which you want to run maintenance. </p>"
"documentation":"<p>Engine attributes that are specific to the server on which you want to run maintenance.</p> <p class=\"title\"> <b>Attributes accepted in a StartMaintenance request for Chef</b> </p> <ul> <li> <p> <code>CHEF_MAJOR_UPGRADE</code>: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to a <code>StartMaintenance</code> request and set the value to <code>true</code> to upgrade the server to Chef Automate 2. For more information, see <a href=\"https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html\">Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2</a>. </p> </li> </ul>"
}
}
},
@ -1177,6 +1264,70 @@
"type":"list",
"member":{"shape":"String"}
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>A tag key, such as <code>Stage</code> or <code>Name</code>. A tag key cannot be empty. The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>An optional tag value, such as <code>Production</code> or <code>test-owcm-server</code>. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p>"
}
},
"documentation":"<p>A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise server. Leading and trailing white spaces are trimmed from both the key and value. A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\\\\\-@]*)$"
},
"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":"AWSOpsWorksCMResourceArn",
"documentation":"<p>The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, <code>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.</p> <ul> <li> <p>The key cannot be empty.</p> </li> <li> <p>The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: <code>+ - = . _ : /</code> </p> </li> <li> <p>Leading and trailing white spaces are trimmed from both the key and value.</p> </li> <li> <p>A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.</p> </li> </ul>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\\\\\-@]*)$"
},
"TimeWindowDefinition":{
"type":"string",
"documentation":"<p> <code>DDD:HH:MM</code> (weekly start time) or <code>HH:MM</code> (daily start time). </p> <p> Time windows always use coordinated universal time (UTC). Valid strings for day of week (<code>DDD</code>) are: <code>Mon</code>, <code>Tue</code>, <code>Wed</code>, <code>Thr</code>, <code>Fri</code>, <code>Sat</code>, or <code>Sun</code>.</p>",
@ -1184,6 +1335,28 @@
"pattern":"^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$"
},
"Timestamp":{"type":"timestamp"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"AWSOpsWorksCMResourceArn",
"documentation":"<p>The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, <code>arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE</code>.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of tags that you want to remove.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateServerEngineAttributesRequest":{
"type":"structure",
"required":[

File diff suppressed because one or more lines are too long

View file

@ -49,6 +49,22 @@
"max":256,
"pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+"
},
"AttributeName":{
"type":"string",
"max":150,
"pattern":"[A-Za-z\\d_]+"
},
"AttributeValue":{
"type":"string",
"max":1000,
"sensitive":true
},
"Context":{
"type":"map",
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeValue"},
"max":150
},
"ErrorMessage":{"type":"string"},
"GetPersonalizedRankingRequest":{
"type":"structure",
@ -64,11 +80,15 @@
},
"inputList":{
"shape":"InputList",
"documentation":"<p>A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list.</p>"
"documentation":"<p>A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.</p>"
},
"userId":{
"shape":"UserID",
"documentation":"<p>The user for which you want the campaign to provide a personalized ranking.</p>"
},
"context":{
"shape":"Context",
"documentation":"<p>The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type. For more information, see Contextual Metadata.</p>"
}
}
},
@ -77,7 +97,7 @@
"members":{
"personalizedRanking":{
"shape":"ItemList",
"documentation":"<p>A list of items in order of most likely interest to the user.</p>"
"documentation":"<p>A list of items in order of most likely interest to the user. The maximum is 500.</p>"
}
}
},
@ -99,7 +119,11 @@
},
"numResults":{
"shape":"NumResults",
"documentation":"<p>The number of results to return. The default is 25. The maximum is 100.</p>"
"documentation":"<p>The number of results to return. The default is 25. The maximum is 500.</p>"
},
"context":{
"shape":"Context",
"documentation":"<p>The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type. For more information, see Contextual Metadata.</p>"
}
}
},
@ -108,7 +132,7 @@
"members":{
"itemList":{
"shape":"ItemList",
"documentation":"<p>A list of recommendations.</p>"
"documentation":"<p>A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.</p>"
}
}
},

View file

@ -132,7 +132,7 @@
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
}
],
"documentation": "<p>Creates a message template that you can use in messages that are sent through the email channel.</p>"
"documentation": "<p>Creates a message template for messages that are sent through the email channel.</p>"
},
"CreateExportJob": {
"name": "CreateExportJob",
@ -296,7 +296,7 @@
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
}
],
"documentation": "<p>Creates a message template that you can use in messages that are sent through a push notification channel.</p>"
"documentation": "<p>Creates a message template for messages that are sent through a push notification channel.</p>"
},
"CreateSegment": {
"name": "CreateSegment",
@ -376,7 +376,7 @@
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
}
],
"documentation": "<p>Creates a message template that you can use in messages that are sent through the SMS channel.</p>"
"documentation": "<p>Creates a message template for messages that are sent through the SMS channel.</p>"
},
"CreateVoiceTemplate": {
"name": "CreateVoiceTemplate",
@ -414,7 +414,7 @@
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
}
],
"documentation": "<p>Creates a message template that you can use in messages that are sent through the voice channel.</p>"
"documentation": "<p>Creates a message template for messages that are sent through the voice channel.</p>"
},
"DeleteAdmChannel": {
"name": "DeleteAdmChannel",
@ -834,7 +834,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Deletes a message template that was designed for use in messages that were sent through the email channel.</p>"
"documentation": "<p>Deletes a message template for messages that were sent through the email channel.</p>"
},
"DeleteEndpoint": {
"name": "DeleteEndpoint",
@ -1044,7 +1044,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Deletes a message template that was designed for use in messages that were sent through a push notification channel.</p>"
"documentation": "<p>Deletes a message template for messages that were sent through a push notification channel.</p>"
},
"DeleteSegment": {
"name": "DeleteSegment",
@ -1170,7 +1170,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Deletes a message template that was designed for use in messages that were sent through the SMS channel.</p>"
"documentation": "<p>Deletes a message template for messages that were sent through the SMS channel.</p>"
},
"DeleteUserEndpoints": {
"name": "DeleteUserEndpoints",
@ -1296,7 +1296,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Deletes a message template that was designed for use in messages that were sent through the voice channel.</p>"
"documentation": "<p>Deletes a message template for messages that were sent through the voice channel.</p>"
},
"GetAdmChannel": {
"name": "GetAdmChannel",
@ -1674,7 +1674,7 @@
"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 of your applications.</p>"
"documentation": "<p>Retrieves information about all the applications that are associated with your Amazon Pinpoint account.</p>"
},
"GetBaiduChannel": {
"name": "GetBaiduChannel",
@ -2094,7 +2094,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel.</p>"
"documentation": "<p>Retrieves the content and settings of a message template for messages that are sent through the email channel.</p>"
},
"GetEndpoint": {
"name": "GetEndpoint",
@ -2598,7 +2598,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel.</p>"
"documentation": "<p>Retrieves the content and settings of a message template for messages that are sent through a push notification channel.</p>"
},
"GetSegment": {
"name": "GetSegment",
@ -2808,7 +2808,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.</p>"
"documentation": "<p>Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.</p>"
},
"GetSegments": {
"name": "GetSegments",
@ -2934,7 +2934,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.</p>"
"documentation": "<p>Retrieves the content and settings of a message template for messages that are sent through the SMS channel.</p>"
},
"GetUserEndpoints": {
"name": "GetUserEndpoints",
@ -3060,7 +3060,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Retrieves the content and settings for a message template that you can use in messages that are sent through the voice channel.</p>"
"documentation": "<p>Retrieves the content and settings of a message template for messages that are sent through the voice channel.</p>"
},
"ListJourneys": {
"name": "ListJourneys",
@ -3118,11 +3118,51 @@
"shape": "ListTagsForResourceResponse",
"documentation": "<p>The request succeeded.</p>"
},
"errors": [
],
"errors": [],
"documentation": "<p>Retrieves all the tags (keys and values) that are associated with an application, campaign, journey, message template, or segment.</p>"
},
"ListTemplateVersions": {
"name": "ListTemplateVersions",
"http": {
"method": "GET",
"requestUri": "/v1/templates/{template-name}/{template-type}/versions",
"responseCode": 200
},
"input": {
"shape": "ListTemplateVersionsRequest"
},
"output": {
"shape": "ListTemplateVersionsResponse",
"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": "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 versions of a specific message template.</p>"
},
"ListTemplates": {
"name": "ListTemplates",
"http": {
@ -3423,9 +3463,7 @@
"input": {
"shape": "TagResourceRequest"
},
"errors": [
],
"errors": [],
"documentation": "<p>Adds one or more tags (keys and values) to an application, campaign, journey, message template, or segment.</p>"
},
"UntagResource": {
@ -3438,9 +3476,7 @@
"input": {
"shape": "UntagResourceRequest"
},
"errors": [
],
"errors": [],
"documentation": "<p>Removes one or more tags (keys and values) from an application, campaign, journey, message template, or segment.</p>"
},
"UpdateAdmChannel": {
@ -3861,7 +3897,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Updates an existing message template that you can use in messages that are sent through the email channel.</p>"
"documentation": "<p>Updates an existing message template for messages that are sent through the email channel.</p>"
},
"UpdateEndpoint": {
"name": "UpdateEndpoint",
@ -4071,7 +4107,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Cancels an active journey.</p>"
"documentation": "<p>Cancels (stops) an active journey.</p>"
},
"UpdatePushTemplate": {
"name": "UpdatePushTemplate",
@ -4113,7 +4149,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Updates an existing message template that you can use in messages that are sent through a push notification channel.</p>"
"documentation": "<p>Updates an existing message template for messages that are sent through a push notification channel.</p>"
},
"UpdateSegment": {
"name": "UpdateSegment",
@ -4239,7 +4275,49 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Updates an existing message template that you can use in messages that are sent through the SMS channel.</p>"
"documentation": "<p>Updates an existing message template for messages that are sent through the SMS channel.</p>"
},
"UpdateTemplateActiveVersion": {
"name": "UpdateTemplateActiveVersion",
"http": {
"method": "PUT",
"requestUri": "/v1/templates/{template-name}/{template-type}/active-version",
"responseCode": 200
},
"input": {
"shape": "UpdateTemplateActiveVersionRequest"
},
"output": {
"shape": "UpdateTemplateActiveVersionResponse",
"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": "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>Changes the status of a specific version of a message template to <i>active</i>.</p>"
},
"UpdateVoiceChannel": {
"name": "UpdateVoiceChannel",
@ -4323,7 +4401,7 @@
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
}
],
"documentation": "<p>Updates an existing message template that you can use in messages that are sent through the voice channel.</p>"
"documentation": "<p>Updates an existing message template for messages that are sent through the voice channel.</p>"
}
},
"shapes": {
@ -5006,7 +5084,7 @@
},
"MultiCondition": {
"shape": "MultiConditionalSplitActivity",
"documentation": "<p>The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.</p>"
"documentation": "<p>The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default <i>Else</i> path) in a journey, based on conditions that you specify.</p>"
},
"RandomSplit": {
"shape": "RandomSplitActivity",
@ -5553,7 +5631,7 @@
},
"FilterType": {
"shape": "FilterType",
"documentation": "<p>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (<link linkend=\"apps-application-id-events\">Events resource</link>) occurs.</p>"
"documentation": "<p>The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (<link linkend=\"apps-application-id-events\">Events</link> resource) occurs.</p>"
}
},
"documentation": "<p>Specifies the settings for events that cause a campaign to be sent.</p>",
@ -5619,7 +5697,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date, ISO 8601 format, when the campaign was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the campaign was created.</p>"
},
"DefaultState": {
"shape": "CampaignState",
@ -5864,11 +5942,11 @@
},
"FalseActivity": {
"shape": "__string",
"documentation": "<p>The unique identifier for the activity to perform if the condition isn't met.</p>"
"documentation": "<p>The unique identifier for the activity to perform if the conditions aren't met.</p>"
},
"TrueActivity": {
"shape": "__string",
"documentation": "<p>The unique identifier for the activity to perform if the condition is met.</p>"
"documentation": "<p>The unique identifier for the activity to perform if the conditions are met.</p>"
}
},
"documentation": "<p>Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.</p>"
@ -5950,8 +6028,7 @@
"type": "structure",
"members": {
"EmailTemplateRequest": {
"shape": "EmailTemplateRequest",
"documentation": "<p>Creates a new message template that you can use in messages that are sent through the email channel.</p>"
"shape": "EmailTemplateRequest"
},
"TemplateName": {
"shape": "__string",
@ -6075,8 +6152,7 @@
"type": "structure",
"members": {
"PushNotificationTemplateRequest": {
"shape": "PushNotificationTemplateRequest",
"documentation": "<p>Creates a message template that you can use in messages that are sent through a push notification channel.</p>"
"shape": "PushNotificationTemplateRequest"
},
"TemplateName": {
"shape": "__string",
@ -6138,8 +6214,7 @@
"type": "structure",
"members": {
"SMSTemplateRequest": {
"shape": "SMSTemplateRequest",
"documentation": "<p>Creates a message template that you can use in messages that are sent through the SMS channel.</p>"
"shape": "SMSTemplateRequest"
},
"TemplateName": {
"shape": "__string",
@ -6538,6 +6613,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -6682,6 +6763,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -6767,6 +6854,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -6852,6 +6945,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -7087,6 +7186,10 @@
"TemplateName": {
"shape": "__string",
"documentation": "<p>The name of the email template to use for the message.</p>"
},
"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>Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.</p>"
@ -7131,7 +7234,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was created.</p>"
},
"DefaultSubstitutions": {
"shape": "__string",
@ -7143,7 +7246,7 @@
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was last modified.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
},
"Subject": {
"shape": "__string",
@ -7169,6 +7272,10 @@
"TextPart": {
"shape": "__string",
"documentation": "<p>The message body, in plain text format, that's used in email messages that are based on the message template.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>"
}
},
"documentation": "<p>Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.</p>",
@ -7259,11 +7366,11 @@
},
"Make": {
"shape": "__string",
"documentation": "<p>The manufacturer of the endpoint device, such as Apple or Samsung.</p>"
"documentation": "<p>The manufacturer of the endpoint device, such as apple or samsung.</p>"
},
"Model": {
"shape": "__string",
"documentation": "<p>The model name or number of the endpoint device, such as iPhone.</p>"
"documentation": "<p>The model name or number of the endpoint device, such as iPhone or SM-G900F.</p>"
},
"ModelVersion": {
"shape": "__string",
@ -7271,7 +7378,7 @@
},
"Platform": {
"shape": "__string",
"documentation": "<p>The platform of the endpoint device, such as iOS or Android.</p>"
"documentation": "<p>The platform of the endpoint device, such as ios.</p>"
},
"PlatformVersion": {
"shape": "__string",
@ -8233,7 +8340,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>"
},
"KpiName": {
"shape": "__string",
@ -8257,7 +8364,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": [
@ -8422,7 +8529,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>"
},
"KpiName": {
"shape": "__string",
@ -8446,7 +8553,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": [
@ -8683,6 +8790,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -9130,6 +9243,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -9428,6 +9547,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -9513,6 +9638,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -9540,7 +9671,7 @@
},
"Percentage": {
"shape": "__integer",
"documentation": "<p>The percentage of participants who shouldn't continue the journey.</p>"
"documentation": "<p>The percentage of participants who shouldn't continue the journey.</p> <p>To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.</p>"
}
},
"documentation": "<p>Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.</p>",
@ -9912,7 +10043,7 @@
"members": {
"Activities": {
"shape": "MapOfActivity",
"documentation": "<p>The configuration and other settings for the activities that comprise the journey.</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.</p>"
},
"ApplicationId": {
"shape": "__string",
@ -9964,7 +10095,7 @@
},
"State": {
"shape": "State",
"documentation": "<p>The current status of the journey. Possible values are:</p> <ul><li><p>DRAFT - The journey is being developed and hasn't been published yet.</p></li> <li><p>ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</p></li> <li><p>COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.</p></li> <li><p>CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.</p></li> <li><p>CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may resume the journey.</p></li></ul>"
"documentation": "<p>The current status of the journey. Possible values are:</p> <ul><li><p>DRAFT - The journey is being developed and hasn't been published yet.</p></li> <li><p>ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.</p></li> <li><p>COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.</p></li> <li><p>CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.</p></li> <li><p>CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.</p></li></ul>"
},
"tags": {
"shape": "MapOf__string",
@ -10088,6 +10219,51 @@
],
"payload": "TagsModel"
},
"ListTemplateVersionsRequest": {
"type": "structure",
"members": {
"NextToken": {
"shape": "__string",
"location": "querystring",
"locationName": "next-token",
"documentation": "<p>The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.</p>"
},
"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>"
},
"TemplateName": {
"shape": "__string",
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"TemplateType": {
"shape": "__string",
"location": "uri",
"locationName": "template-type",
"documentation": "<p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>"
}
},
"required": [
"TemplateName",
"TemplateType"
]
},
"ListTemplateVersionsResponse": {
"type": "structure",
"members": {
"TemplateVersionsResponse": {
"shape": "TemplateVersionsResponse"
}
},
"required": [
"TemplateVersionsResponse"
],
"payload": "TemplateVersionsResponse"
},
"ListTemplatesRequest": {
"type": "structure",
"members": {
@ -10113,7 +10289,7 @@
"shape": "__string",
"location": "querystring",
"locationName": "template-type",
"documentation": "<p>The type of message template to include in the results. Valid values are: EMAIL, SMS, PUSH, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>"
"documentation": "<p>The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.</p>"
}
}
},
@ -10392,14 +10568,14 @@
},
"DefaultActivity": {
"shape": "__string",
"documentation": "<p>The activity to perform by default for any path in the activity.</p>"
"documentation": "<p>The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.</p>"
},
"EvaluationWaitTime": {
"shape": "WaitTime",
"documentation": "<p>The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.</p>"
}
},
"documentation": "<p>Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.</p>"
"documentation": "<p>Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths (including a default <i>Else</i> path) in a journey, based on conditions that you specify.</p>"
},
"NotFoundException": {
"type": "structure",
@ -10636,7 +10812,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was created.</p>"
},
"Default": {
"shape": "DefaultPushNotificationTemplate",
@ -10652,7 +10828,7 @@
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was last modified.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
},
"tags": {
"shape": "MapOf__string",
@ -10670,14 +10846,18 @@
"TemplateType": {
"shape": "TemplateType",
"documentation": "<p>The type of channel that the message template is designed for. For a push notification template, this value is PUSH.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>"
}
},
"documentation": "<p>Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.</p>",
"required": [
"LastModifiedDate",
"CreationDate",
"TemplateName",
"TemplateType"
"TemplateType",
"TemplateName"
]
},
"PutEventStreamRequest": {
@ -10775,7 +10955,7 @@
},
"Percentage": {
"shape": "__integer",
"documentation": "<p>The percentage of participants to send down the activity path.</p>"
"documentation": "<p>The percentage of participants to send down the activity path.</p> <p>To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.</p>"
}
},
"documentation": "<p>Specifies the settings for a path in a random split activity in a journey.</p>"
@ -11046,7 +11226,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was created.</p>"
},
"DefaultSubstitutions": {
"shape": "__string",
@ -11054,7 +11234,7 @@
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was last modified.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
},
"tags": {
"shape": "MapOf__string",
@ -11072,6 +11252,10 @@
"TemplateType": {
"shape": "TemplateType",
"documentation": "<p>The type of channel that the message template is designed for. For an SMS template, this value is SMS.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>"
}
},
"documentation": "<p>Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.</p>",
@ -11670,9 +11854,23 @@
"Name": {
"shape": "__string",
"documentation": "<p>The name of the message template to use for the message. If specified, this value must match the name of an existing message template.</p>"
},
"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>Specifies the name of the message template to use for the message.</p>"
"documentation": "<p>Specifies the name and version of the message template to use for the message.</p>"
},
"TemplateActiveVersionRequest": {
"type": "structure",
"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>Specifies which version of a message template to use as the active version of the template.</p>"
},
"TemplateConfiguration": {
"type": "structure",
@ -11705,7 +11903,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was created.</p>"
},
"DefaultSubstitutions": {
"shape": "__string",
@ -11713,7 +11911,7 @@
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was last modified.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
},
"tags": {
"shape": "MapOf__string",
@ -11730,7 +11928,11 @@
},
"TemplateType": {
"shape": "TemplateType",
"documentation": "<p>The type of channel that the message template is designed for.</p>"
"documentation": "<p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier, as an integer, for the active version of the message template.</p>"
}
},
"documentation": "<p>Provides information about a message template that's associated with your Amazon Pinpoint account.</p>",
@ -11750,6 +11952,71 @@
"PUSH"
]
},
"TemplateVersionResponse": {
"type": "structure",
"members": {
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date, in ISO 8601 format, when the version of the message template was created.</p>"
},
"DefaultSubstitutions": {
"shape": "__string",
"documentation": "<p>A JSON object that specifies the default values that are used for message variables in the version of 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>"
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date, in ISO 8601 format, when the version of the message template was last modified.</p>"
},
"TemplateDescription": {
"shape": "__string",
"documentation": "<p>The custom description of the version of the message template.</p>"
},
"TemplateName": {
"shape": "__string",
"documentation": "<p>The name of the message template.</p>"
},
"TemplateType": {
"shape": "__string",
"documentation": "<p>The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.</p>"
}
},
"documentation": "<p>Provides information about a specific version of a message template.</p>",
"required": [
"LastModifiedDate",
"CreationDate",
"TemplateName",
"TemplateType"
]
},
"TemplateVersionsResponse": {
"type": "structure",
"members": {
"Item": {
"shape": "ListOfTemplateVersionResponse",
"documentation": "<p>An array of responses, one for each version of the message template.</p>"
},
"Message": {
"shape": "__string",
"documentation": "<p>The message that's returned from the API for the request to retrieve information about all the versions of the message template.</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>"
},
"RequestID": {
"shape": "__string",
"documentation": "<p>The unique identifier for the request to retrieve information about all the versions of the message template.</p>"
}
},
"documentation": "<p>Provides information about all the versions of a specific message template.</p>",
"required": [
"Item"
]
},
"TemplatesResponse": {
"type": "structure",
"members": {
@ -12155,6 +12422,12 @@
"UpdateEmailTemplateRequest": {
"type": "structure",
"members": {
"CreateNewVersion": {
"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>"
},
"EmailTemplateRequest": {
"shape": "EmailTemplateRequest"
},
@ -12163,6 +12436,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -12362,15 +12641,26 @@
"UpdatePushTemplateRequest": {
"type": "structure",
"members": {
"CreateNewVersion": {
"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>"
},
"PushNotificationTemplateRequest": {
"shape": "PushNotificationTemplateRequest",
"documentation": "<p>Updates an existing message template that you can use in messages that are sent through a push notification channel.</p>"
"shape": "PushNotificationTemplateRequest"
},
"TemplateName": {
"shape": "__string",
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -12463,6 +12753,12 @@
"UpdateSmsTemplateRequest": {
"type": "structure",
"members": {
"CreateNewVersion": {
"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>"
},
"SMSTemplateRequest": {
"shape": "SMSTemplateRequest"
},
@ -12471,6 +12767,12 @@
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
}
},
"required": [
@ -12491,6 +12793,44 @@
],
"payload": "MessageBody"
},
"UpdateTemplateActiveVersionRequest": {
"type": "structure",
"members": {
"TemplateActiveVersionRequest": {
"shape": "TemplateActiveVersionRequest"
},
"TemplateName": {
"shape": "__string",
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"TemplateType": {
"shape": "__string",
"location": "uri",
"locationName": "template-type",
"documentation": "<p>The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.</p>"
}
},
"required": [
"TemplateName",
"TemplateType",
"TemplateActiveVersionRequest"
],
"payload": "TemplateActiveVersionRequest"
},
"UpdateTemplateActiveVersionResponse": {
"type": "structure",
"members": {
"MessageBody": {
"shape": "MessageBody"
}
},
"required": [
"MessageBody"
],
"payload": "MessageBody"
},
"UpdateVoiceChannelRequest": {
"type": "structure",
"members": {
@ -12525,12 +12865,24 @@
"UpdateVoiceTemplateRequest": {
"type": "structure",
"members": {
"CreateNewVersion": {
"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>"
},
"TemplateName": {
"shape": "__string",
"location": "uri",
"locationName": "template-name",
"documentation": "<p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>"
},
"Version": {
"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>"
},
"VoiceTemplateRequest": {
"shape": "VoiceTemplateRequest"
}
@ -12682,7 +13034,7 @@
},
"CreationDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was created.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was created.</p>"
},
"DefaultSubstitutions": {
"shape": "__string",
@ -12694,7 +13046,7 @@
},
"LastModifiedDate": {
"shape": "__string",
"documentation": "<p>The date when the message template was last modified.</p>"
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
},
"tags": {
"shape": "MapOf__string",
@ -12713,6 +13065,10 @@
"shape": "TemplateType",
"documentation": "<p>The type of channel that the message template is designed for. For a voice template, this value is VOICE.</p>"
},
"Version": {
"shape": "__string",
"documentation": "<p>The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.</p>"
},
"VoiceId": {
"shape": "__string",
"documentation": "<p>The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/what-is.html\">Amazon Polly Developer Guide</a>.</p>"
@ -12866,7 +13222,7 @@
"members": {
"Activities": {
"shape": "MapOfActivity",
"documentation": "<p>The configuration and other settings for the activities that comprise the journey.</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 128 characters. The characters must be alphanumeric characters.</p>"
},
"CreationDate": {
"shape": "__string",
@ -12902,7 +13258,7 @@
},
"StartActivity": {
"shape": "__string",
"documentation": "<p>The unique identifier for the first activity in the journey.</p>"
"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>"
},
"StartCondition": {
"shape": "StartCondition",
@ -13091,6 +13447,12 @@
"shape": "TemplateResponse"
}
},
"ListOfTemplateVersionResponse": {
"type": "list",
"member": {
"shape": "TemplateVersionResponse"
}
},
"ListOfTreatmentResource": {
"type": "list",
"member": {

View file

@ -204,6 +204,12 @@
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "Targets"
},
"DescribeExportTasks": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "ExportTasks"
}
}
}

View file

@ -127,6 +127,23 @@
],
"documentation":"<p>Backtracks a DB cluster to a specific time, without creating a new DB cluster.</p> <p>For more information on backtracking, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html\"> Backtracking an Aurora DB Cluster</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"CancelExportTask":{
"name":"CancelExportTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelExportTaskMessage"},
"output":{
"shape":"ExportTask",
"resultWrapper":"CancelExportTaskResult"
},
"errors":[
{"shape":"ExportTaskNotFoundFault"},
{"shape":"InvalidExportTaskStateFault"}
],
"documentation":"<p>Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed. </p>"
},
"CopyDBClusterParameterGroup":{
"name":"CopyDBClusterParameterGroup",
"http":{
@ -164,7 +181,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 copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.</p> <p>The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an AWS SDK tool or the AWS CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the AWS CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.</p> </note> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL. </p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p> <p>For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html\"> Copying a Snapshot</a> in the <i>Amazon Aurora User Guide.</i> </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>"
"documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the <code>CopyDBClusterSnapshot</code> action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>PreSignedUrl</code> - A URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.</p> <p>The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot is to be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an AWS SDK tool or the AWS CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the AWS CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.</p> </note> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the <code>SourceDBClusterSnapshotIdentifier</code> in the pre-signed URL. </p> </li> </ul> <p>To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in \"copying\" status.</p> <p>For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html\"> Copying a Snapshot</a> in the <i>Amazon Aurora User Guide.</i> </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>"
},
"CopyDBParameterGroup":{
"name":"CopyDBParameterGroup",
@ -202,7 +219,7 @@
{"shape":"SnapshotQuotaExceededFault"},
{"shape":"KMSKeyNotAccessibleFault"}
],
"documentation":"<p>Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.</p> <p>You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the <code>CopyDBSnapshot</code> action is the destination AWS Region for the DB snapshot copy. </p> <p>For more information about copying snapshots, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopyDBSnapshot.html\">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide.</i> </p>"
"documentation":"<p>Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.</p> <p>You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the <code>CopyDBSnapshot</code> action is the destination AWS Region for the DB snapshot copy. </p> <p>For more information about copying snapshots, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBSnapshot\">Copying a DB Snapshot</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"CopyOptionGroup":{
"name":"CopyOptionGroup",
@ -511,7 +528,7 @@
{"shape":"SubscriptionCategoryNotFoundFault"},
{"shape":"SourceNotFoundFault"}
],
"documentation":"<p>Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.</p> <p>You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.</p> <p>If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.</p> <note> <p>RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.</p> </note>"
"documentation":"<p>Creates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.</p> <p>You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.</p> <p>If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.</p> <note> <p>RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.</p> </note>"
},
"CreateGlobalCluster":{
"name":"CreateGlobalCluster",
@ -653,7 +670,7 @@
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBInstanceAutomatedBackupQuotaExceededFault"}
],
"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 RDS 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 you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p> <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a Read Replica of another Amazon Aurora DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first call the <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>"
"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 RDS 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>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 you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p> <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a Read Replica of another Amazon Aurora DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first call the <code>PromoteReadReplicaDBCluster</code> API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the <code>DeleteDBInstance</code> API action to delete the final instance in the DB cluster.</p>"
},
"DeleteDBInstanceAutomatedBackup":{
"name":"DeleteDBInstanceAutomatedBackup",
@ -983,7 +1000,7 @@
"errors":[
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Returns information about provisioned Aurora DB clusters. This API supports pagination.</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>"
"documentation":"<p>Returns information about provisioned Aurora DB clusters. This API supports pagination.</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 operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p> </note>"
},
"DescribeDBEngineVersions":{
"name":"DescribeDBEngineVersions",
@ -1028,7 +1045,7 @@
"errors":[
{"shape":"DBInstanceNotFoundFault"}
],
"documentation":"<p>Returns information about provisioned RDS instances. This API supports pagination.</p>"
"documentation":"<p>Returns information about provisioned RDS instances. This API supports pagination.</p> <note> <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p> </note>"
},
"DescribeDBLogFiles":{
"name":"DescribeDBLogFiles",
@ -1260,6 +1277,22 @@
},
"documentation":"<p>Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.</p>"
},
"DescribeExportTasks":{
"name":"DescribeExportTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeExportTasksMessage"},
"output":{
"shape":"ExportTasksMessage",
"resultWrapper":"DescribeExportTasksResult"
},
"errors":[
{"shape":"ExportTaskNotFoundFault"}
],
"documentation":"<p>Returns information about a snapshot export to Amazon S3. This API operation supports pagination. </p>"
},
"DescribeGlobalClusters":{
"name":"DescribeGlobalClusters",
"http":{
@ -1482,6 +1515,22 @@
],
"documentation":"<p>Lists all tags on an Amazon RDS resource.</p> <p>For an overview on tagging an Amazon RDS resource, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">Tagging Amazon RDS Resources</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"ModifyCertificates":{
"name":"ModifyCertificates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyCertificatesMessage"},
"output":{
"shape":"ModifyCertificatesResult",
"resultWrapper":"ModifyCertificatesResult"
},
"errors":[
{"shape":"CertificateNotFoundFault"}
],
"documentation":"<p>Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, or remove the override.</p> <p>By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.</p> <p>You might need to override the default certificate in the following situations:</p> <ul> <li> <p>You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region.</p> </li> <li> <p>RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.</p> </li> </ul> <p>For more information about rotating your SSL/TLS certificate for RDS DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about rotating your SSL/TLS certificate for Aurora DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"ModifyCurrentDBClusterCapacity":{
"name":"ModifyCurrentDBClusterCapacity",
"http":{
@ -1739,7 +1788,7 @@
{"shape":"SNSTopicArnNotFoundFault"},
{"shape":"SubscriptionCategoryNotFoundFault"}
],
"documentation":"<p>Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the <code>AddSourceIdentifierToSubscription</code> and <code>RemoveSourceIdentifierFromSubscription</code> calls.</p> <p>You can see a list of the event categories for a given SourceType in the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> topic in the <i>Amazon RDS User Guide</i> or by using the <b>DescribeEventCategories</b> action.</p>"
"documentation":"<p>Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the <code>AddSourceIdentifierToSubscription</code> and <code>RemoveSourceIdentifierFromSubscription</code> calls.</p> <p>You can see a list of the event categories for a given SourceType in the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html\">Events</a> topic in the <i>Amazon RDS User Guide</i> or by using the <b>DescribeEventCategories</b> action.</p>"
},
"ModifyGlobalCluster":{
"name":"ModifyGlobalCluster",
@ -2038,7 +2087,7 @@
{"shape":"DomainNotFoundFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"}
],
"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>"
"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>"
},
"RestoreDBClusterToPointInTime":{
"name":"RestoreDBClusterToPointInTime",
@ -2260,6 +2309,30 @@
],
"documentation":"<p> Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html\"> Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p> This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use <code>StartDBCluster</code> instead. </p> </note>"
},
"StartExportTask":{
"name":"StartExportTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartExportTaskMessage"},
"output":{
"shape":"ExportTask",
"resultWrapper":"StartExportTaskResult"
},
"errors":[
{"shape":"DBSnapshotNotFoundFault"},
{"shape":"DBClusterSnapshotNotFoundFault"},
{"shape":"ExportTaskAlreadyExistsFault"},
{"shape":"InvalidS3BucketFault"},
{"shape":"IamRoleNotFoundFault"},
{"shape":"IamRoleMissingPermissionsFault"},
{"shape":"InvalidExportOnlyFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"InvalidExportSourceStateFault"}
],
"documentation":"<p>Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. </p>"
},
"StopActivityStream":{
"name":"StopActivityStream",
"http":{
@ -2346,7 +2419,7 @@
"documentation":"<p>The maximum allowed value for the quota.</p>"
}
},
"documentation":"<p>Describes a quota for an AWS account.</p> <p>The following are account quotas:</p> <ul> <li> <p> <code>AllocatedStorage</code> - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.</p> </li> <li> <p> <code>AuthorizationsPerDBSecurityGroup</code> - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.</p> </li> <li> <p> <code>CustomEndpointsPerDBCluster</code> - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.</p> </li> <li> <p> <code>DBClusterParameterGroups</code> - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.</p> </li> <li> <p> <code>DBClusterRoles</code> - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.</p> </li> <li> <p> <code>DBClusters</code> - The number of DB clusters per account. The used value is the count of DB clusters in the account.</p> </li> <li> <p> <code>DBInstanceRoles</code> - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.</p> </li> <li> <p> <code>DBInstances</code> - The number of DB instances per account. The used value is the count of the DB instances in the account.</p> </li> <li> <p> <code>DBParameterGroups</code> - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.</p> </li> <li> <p> <code>DBSecurityGroups</code> - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.</p> </li> <li> <p> <code>DBSubnetGroups</code> - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.</p> </li> <li> <p> <code>EventSubscriptions</code> - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.</p> </li> <li> <p> <code>ManualSnapshots</code> - The number of manual DB snapshots per account. The used value is the count of the manual DB snapshots in the account.</p> </li> <li> <p> <code>OptionGroups</code> - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.</p> </li> <li> <p> <code>ReadReplicasPerMaster</code> - The number of Read Replicas per DB instance. The used value is the highest number of Read Replicas for a DB instance in the account. Other DB instances in the account might have a lower number of Read Replicas.</p> </li> <li> <p> <code>ReservedDBInstances</code> - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.</p> </li> <li> <p> <code>SubnetsPerDBSubnetGroup</code> - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html\">Limits</a> in the <i>Amazon RDS User Guide</i> and <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html\">Limits</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"documentation":"<p>Describes a quota for an AWS account.</p> <p>The following are account quotas:</p> <ul> <li> <p> <code>AllocatedStorage</code> - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.</p> </li> <li> <p> <code>AuthorizationsPerDBSecurityGroup</code> - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.</p> </li> <li> <p> <code>CustomEndpointsPerDBCluster</code> - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.</p> </li> <li> <p> <code>DBClusterParameterGroups</code> - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.</p> </li> <li> <p> <code>DBClusterRoles</code> - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.</p> </li> <li> <p> <code>DBClusters</code> - The number of DB clusters per account. The used value is the count of DB clusters in the account.</p> </li> <li> <p> <code>DBInstanceRoles</code> - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.</p> </li> <li> <p> <code>DBInstances</code> - The number of DB instances per account. The used value is the count of the DB instances in the account.</p> <p>Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.</p> </li> <li> <p> <code>DBParameterGroups</code> - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.</p> </li> <li> <p> <code>DBSecurityGroups</code> - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.</p> </li> <li> <p> <code>DBSubnetGroups</code> - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.</p> </li> <li> <p> <code>EventSubscriptions</code> - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.</p> </li> <li> <p> <code>ManualSnapshots</code> - The number of manual DB snapshots per account. The used value is the count of the manual DB snapshots in the account.</p> </li> <li> <p> <code>OptionGroups</code> - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.</p> </li> <li> <p> <code>ReadReplicasPerMaster</code> - The number of Read Replicas per DB instance. The used value is the highest number of Read Replicas for a DB instance in the account. Other DB instances in the account might have a lower number of Read Replicas.</p> </li> <li> <p> <code>ReservedDBInstances</code> - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.</p> </li> <li> <p> <code>SubnetsPerDBSubnetGroup</code> - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html\">Quotas for Amazon RDS</a> in the <i>Amazon RDS User Guide</i> and <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html\">Quotas for Amazon Aurora</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"wrapper":true
},
"AccountQuotaList":{
@ -2664,6 +2737,16 @@
},
"Boolean":{"type":"boolean"},
"BooleanOptional":{"type":"boolean"},
"CancelExportTaskMessage":{
"type":"structure",
"required":["ExportTaskIdentifier"],
"members":{
"ExportTaskIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the snapshot export task to cancel.</p>"
}
}
},
"Certificate":{
"type":"structure",
"members":{
@ -2690,6 +2773,14 @@
"CertificateArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the certificate.</p>"
},
"CustomerOverride":{
"shape":"BooleanOptional",
"documentation":"<p>Whether there is an override for the default certificate identifier.</p>"
},
"CustomerOverrideValidTill":{
"shape":"TStamp",
"documentation":"<p>If there is an override for the default certificate identifier, when the override expires.</p>"
}
},
"documentation":"<p>A CA certificate for an AWS account.</p>",
@ -2854,11 +2945,11 @@
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. </p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. </p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted DB cluster snapshot to another AWS Region, you must set <code>KmsKeyId</code> to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
"documentation":"<p>The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. </p> <p>If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. </p> <p>If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted DB cluster snapshot to another AWS Region, you must set <code>KmsKeyId</code> to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</p> <p>If you copy an unencrypted DB cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
},
"PreSignedUrl":{
"shape":"String",
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. The <code>PreSignedUrl</code> parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify <code>PreSignedUrl</code> when you are copying an encrypted DB cluster snapshot in the same AWS Region.</p> <p>The pre-signed URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an AWS SDK tool or the AWS CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the AWS CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.</p> </note>"
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source DB cluster snapshot to copy. The <code>PreSignedUrl</code> parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify <code>PreSignedUrl</code> when you are copying an encrypted DB cluster snapshot in the same AWS Region.</p> <p>The pre-signed URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the pre-signed URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot is to be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115</code>.</p> </li> </ul> <p>To learn how to generate a Signature Version 4 signed request, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\"> Authenticating Requests: Using Query Parameters (AWS Signature Version 4)</a> and <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\"> Signature Version 4 Signing Process</a>.</p> <note> <p>If you are using an AWS SDK tool or the AWS CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the AWS CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.</p> </note>"
},
"CopyTags":{
"shape":"BooleanOptional",
@ -3059,7 +3150,7 @@
},
"DatabaseName":{
"shape":"String",
"documentation":"<p>The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.</p>"
"documentation":"<p>The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
@ -3143,7 +3234,7 @@
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>"
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p> <p>Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the <i>Amazon Aurora User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations\"> Limitations of Aurora Serverless</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations\"> Limitations of Parallel Query</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations\"> Requirements for Aurora Global Databases</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations\"> Limitations of Multi-Master Clusters</a> </p> </li> </ul>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
@ -3329,7 +3420,7 @@
},
"OptionGroupName":{
"shape":"String",
"documentation":"<p>Indicates that the DB instance should be associated with the specified option group.</p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance</p>"
"documentation":"<p>Indicates that the DB instance should be associated with the specified option group.</p> <p>Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance</p>"
},
"CharacterSetName":{
"shape":"String",
@ -3773,7 +3864,7 @@
},
"SourceIds":{
"shape":"SourceIdsList",
"documentation":"<p>The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p> <p>Constraints:</p> <ul> <li> <p>If SourceIds are supplied, SourceType must also be provided.</p> </li> <li> <p>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</p> </li> </ul>"
"documentation":"<p>The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.</p> <p>Constraints:</p> <ul> <li> <p>If SourceIds are supplied, SourceType must also be provided.</p> </li> <li> <p>If the source type is a DB instance, then a <code>DBInstanceIdentifier</code> must be supplied.</p> </li> <li> <p>If the source type is a DB security group, a <code>DBSecurityGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB parameter group, a <code>DBParameterGroupName</code> must be supplied.</p> </li> <li> <p>If the source type is a DB snapshot, a <code>DBSnapshotIdentifier</code> must be supplied.</p> </li> </ul>"
},
"Enabled":{
"shape":"BooleanOptional",
@ -4207,7 +4298,7 @@
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent <code>DescribeDBClusterBacktracks</code> request.</p>"
"documentation":"<p>A pagination token that can be used in a later <code>DescribeDBClusterBacktracks</code> request.</p>"
},
"DBClusterBacktracks":{
"shape":"DBClusterBacktrackList",
@ -4397,7 +4488,7 @@
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent DescribeDBClusters request.</p>"
"documentation":"<p>A pagination token that can be used in a later DescribeDBClusters request.</p>"
},
"DBClusters":{
"shape":"DBClusterList",
@ -5628,7 +5719,7 @@
},
"TrackedClusterId":{
"shape":"String",
"documentation":"<p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an </p>"
"documentation":"<p>The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.</p>"
},
"RdsResourceId":{
"shape":"String",
@ -6294,7 +6385,7 @@
},
"SkipFinalSnapshot":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.</p> <p>Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.</p> <p>Specify skip when deleting a Read Replica.</p> <note> <p>The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.</p> </note>"
"documentation":"<p>A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.</p> <p>When a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.</p> <p>Specify skip when deleting a Read Replica.</p> <note> <p>The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.</p> </note>"
},
"FinalDBSnapshotIdentifier":{
"shape":"String",
@ -6856,7 +6947,7 @@
},
"Marker":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent DescribeDBLogFiles request.</p>"
"documentation":"<p>A pagination token that can be used in a later DescribeDBLogFiles request.</p>"
}
},
"documentation":"<p> The response from a call to <code>DescribeDBLogFiles</code>. </p>"
@ -7260,6 +7351,31 @@
},
"documentation":"<p/>"
},
"DescribeExportTasksMessage":{
"type":"structure",
"members":{
"ExportTaskIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the snapshot export task to be described.</p>"
},
"SourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output.</p> <p>Supported filters include the following: </p> <ul> <li> <p> <code>export-task-identifier</code> - An identifier for the snapshot export task.</p> </li> <li> <p> <code>s3-bucket</code> - The Amazon S3 bucket the snapshot is exported to.</p> </li> <li> <p> <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3</p> </li> <li> <p> <code>status</code> - The status of the export task.</p> </li> </ul>"
},
"Marker":{
"shape":"String",
"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",
"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>"
}
}
},
"DescribeGlobalClustersMessage":{
"type":"structure",
"members":{
@ -7625,7 +7741,7 @@
},
"Marker":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.</p>"
"documentation":"<p>A pagination token that can be used in a later DownloadDBLogFilePortion request.</p>"
},
"AdditionalDataPending":{
"shape":"Boolean",
@ -7904,6 +8020,116 @@
},
"documentation":"<p> Contains the result of a successful invocation of the <code>DescribeEvents</code> action. </p>"
},
"ExportTask":{
"type":"structure",
"members":{
"ExportTaskIdentifier":{
"shape":"String",
"documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to. </p>"
},
"SourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.</p>"
},
"ExportOnly":{
"shape":"StringList",
"documentation":"<p>The data exported from the snapshot. Valid values are the following:</p> <ul> <li> <p> <code>database</code> - Export all the data of the snapshot.</p> </li> <li> <p> <code>database.table [table-name]</code> - Export a table of the snapshot.</p> </li> <li> <p> <code>database.schema [schema-name]</code> - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.</p> </li> <li> <p> <code>database.schema.table [table-name]</code> - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.</p> </li> </ul>"
},
"SnapshotTime":{
"shape":"TStamp",
"documentation":"<p>The time that the snapshot was created.</p>"
},
"TaskStartTime":{
"shape":"TStamp",
"documentation":"<p>The time that the snapshot export task started.</p>"
},
"TaskEndTime":{
"shape":"TStamp",
"documentation":"<p>The time that the snapshot export task completed.</p>"
},
"S3Bucket":{
"shape":"String",
"documentation":"<p>The Amazon S3 bucket that the snapshot is exported to.</p>"
},
"S3Prefix":{
"shape":"String",
"documentation":"<p>The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.</p>"
},
"IamRoleArn":{
"shape":"String",
"documentation":"<p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot. </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the AWS KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key. </p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The progress status of the export task.</p>"
},
"PercentProgress":{
"shape":"Integer",
"documentation":"<p>The progress of the snapshot export task as a percentage.</p>"
},
"TotalExtractedDataInGB":{
"shape":"Integer",
"documentation":"<p>The total amount of data exported, in gigabytes.</p>"
},
"FailureCause":{
"shape":"String",
"documentation":"<p>The reason the export failed, if it failed.</p>"
},
"WarningMessage":{
"shape":"String",
"documentation":"<p>A warning about the snapshot export task.</p>"
}
},
"documentation":"<p>Contains the details of a snapshot export to Amazon S3. </p> <p>This data type is used as a response element in the <code>DescribeExportTasks</code> action. </p>"
},
"ExportTaskAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You can't start an export task that's already running.</p>",
"error":{
"code":"ExportTaskAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ExportTaskNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The export task doesn't exist.</p>",
"error":{
"code":"ExportTaskNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ExportTasksList":{
"type":"list",
"member":{
"shape":"ExportTask",
"locationName":"ExportTask"
}
},
"ExportTasksMessage":{
"type":"structure",
"members":{
"Marker":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a later <code>DescribeExportTasks</code> request. A marker is used for pagination to identify the location to begin output for the next response of <code>DescribeExportTasks</code>.</p>"
},
"ExportTasks":{
"shape":"ExportTasksList",
"documentation":"<p>Information about an export of a snapshot to Amazon S3.</p>"
}
}
},
"FailoverDBClusterMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
@ -8118,6 +8344,30 @@
"locationName":"IPRange"
}
},
"IamRoleMissingPermissionsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The IAM role requires additional permissions to export to an Amazon S3 bucket.</p>",
"error":{
"code":"IamRoleMissingPermissions",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"IamRoleNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The IAM role is missing for exporting to an Amazon S3 bucket.</p>",
"error":{
"code":"IamRoleNotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ImportInstallationMediaMessage":{
"type":"structure",
"required":[
@ -8460,6 +8710,42 @@
},
"exception":true
},
"InvalidExportOnlyFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The export is invalid for exporting to an Amazon S3 bucket.</p>",
"error":{
"code":"InvalidExportOnly",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidExportSourceStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The state of the export snapshot is invalid for exporting to an Amazon S3 bucket.</p>",
"error":{
"code":"InvalidExportSourceState",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidExportTaskStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You can't cancel an export task that has completed.</p>",
"error":{
"code":"InvalidExportTaskStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidGlobalClusterStateFault":{
"type":"structure",
"members":{
@ -8595,6 +8881,25 @@
"locationName":"MinimumEngineVersionPerAllowedValue"
}
},
"ModifyCertificatesMessage":{
"type":"structure",
"members":{
"CertificateIdentifier":{
"shape":"String",
"documentation":"<p>The new default certificate identifier to override the current one with.</p> <p>To determine the valid values, use the <code>describe-certificates</code> AWS CLI command or the <code>DescribeCertificates</code> API operation.</p>"
},
"RemoveCustomerOverride":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.</p>"
}
}
},
"ModifyCertificatesResult":{
"type":"structure",
"members":{
"Certificate":{"shape":"Certificate"}
}
},
"ModifyCurrentDBClusterCapacityMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
@ -8953,6 +9258,10 @@
"MaxAllocatedStorage":{
"shape":"IntegerOptional",
"documentation":"<p>The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.</p>"
},
"CertificateRotationRestart":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate.</p> <p>By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.</p> <important> <p>Set this parameter only if you are <i>not</i> using SSL/TLS to connect to the DB instance.</p> </important> <p>If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:</p> <ul> <li> <p>For more information about rotating your SSL/TLS certificate for RDS DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate.</a> in the <i>Amazon RDS User Guide.</i> </p> </li> <li> <p>For more information about rotating your SSL/TLS certificate for Aurora DB engines, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html\"> Rotating Your SSL/TLS Certificate</a> in the <i>Amazon Aurora User Guide.</i> </p> </li> </ul>"
}
},
"documentation":"<p/>"
@ -8976,7 +9285,7 @@
},
"Parameters":{
"shape":"ParametersList",
"documentation":"<p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.</p> <p>Valid Values (for the application method): <code>immediate | pending-reboot</code> </p> <note> <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p> </note>"
"documentation":"<p>An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.</p> <p>Valid Values (for the application method): <code>immediate | pending-reboot</code> </p> <note> <p>You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.</p> </note>"
}
},
"documentation":"<p/>"
@ -11668,6 +11977,46 @@
"DBInstance":{"shape":"DBInstance"}
}
},
"StartExportTaskMessage":{
"type":"structure",
"required":[
"ExportTaskIdentifier",
"SourceArn",
"S3BucketName",
"IamRoleArn",
"KmsKeyId"
],
"members":{
"ExportTaskIdentifier":{
"shape":"String",
"documentation":"<p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to. </p>"
},
"SourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.</p>"
},
"S3BucketName":{
"shape":"String",
"documentation":"<p>The name of the Amazon S3 bucket to export the snapshot to.</p>"
},
"IamRoleArn":{
"shape":"String",
"documentation":"<p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot. </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key. </p>"
},
"S3Prefix":{
"shape":"String",
"documentation":"<p>The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.</p>"
},
"ExportOnly":{
"shape":"StringList",
"documentation":"<p>The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:</p> <ul> <li> <p> <code>database</code> - Export all the data of the snapshot.</p> </li> <li> <p> <code>database.table [table-name]</code> - Export a table of the snapshot.</p> </li> <li> <p> <code>database.schema [schema-name]</code> - Export a database schema of the snapshot. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.</p> </li> <li> <p> <code>database.schema.table [table-name]</code> - Export a table of the database schema. This value isn't valid for RDS for MySQL, RDS for MariaDB, or Aurora MySQL.</p> </li> </ul>"
}
}
},
"StopActivityStreamRequest":{
"type":"structure",
"required":["ResourceArn"],
@ -12118,5 +12467,5 @@
"documentation":"<p>Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.</p> <p>For more information about RDS on VMware, see the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html\"> <i>RDS on VMware User Guide.</i> </a> </p>"
}
},
"documentation":"<fullname>Amazon Relational Database Service</fullname> <p> </p> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html\">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html\">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html\">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html\">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces\">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html\">Using the Query API</a>.</p> </li> </ul>"
"documentation":"<fullname>Amazon Relational Database Service</fullname> <p> </p> <p>Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.</p> <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.</p> <p>This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.</p> <p> <b>Amazon RDS API Reference</b> </p> <ul> <li> <p>For the alphabetical list of API actions, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Operations.html\">API Actions</a>.</p> </li> <li> <p>For the alphabetical list of data types, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Types.html\">Data Types</a>.</p> </li> <li> <p>For a list of common query parameters, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonParameters.html\">Common Parameters</a>.</p> </li> <li> <p>For descriptions of the error codes, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/CommonErrors.html\">Common Errors</a>.</p> </li> </ul> <p> <b>Amazon RDS User Guide</b> </p> <ul> <li> <p>For a summary of the Amazon RDS interfaces, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html#Welcome.Interfaces\">Available RDS Interfaces</a>.</p> </li> <li> <p>For more information about how to use the Query API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Using_the_Query_API.html\">Using the Query API</a>.</p> </li> </ul>"
}

View file

@ -104,7 +104,7 @@
{"shape":"InvalidRetentionPeriodFault"},
{"shape":"BatchModifyClusterSnapshotsLimitExceededFault"}
],
"documentation":"<p>Modifies the settings for a list of snapshots.</p>"
"documentation":"<p>Modifies the settings for a set of cluster snapshots.</p>"
},
"CancelResize":{
"name":"CancelResize",
@ -123,7 +123,7 @@
{"shape":"InvalidClusterStateFault"},
{"shape":"UnsupportedOperationFault"}
],
"documentation":"<p>Cancels a resize operation.</p>"
"documentation":"<p>Cancels a resize operation for a cluster.</p>"
},
"CopyClusterSnapshot":{
"name":"CopyClusterSnapshot",
@ -180,7 +180,7 @@
{"shape":"SnapshotScheduleNotFoundFault"},
{"shape":"InvalidRetentionPeriodFault"}
],
"documentation":"<p>Creates a new cluster.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
"documentation":"<p>Creates a new cluster with the specified parameters.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"CreateClusterParameterGroup":{
"name":"CreateClusterParameterGroup",
@ -389,7 +389,7 @@
{"shape":"TagLimitExceededFault"},
{"shape":"ScheduleDefinitionTypeUnsupportedFault"}
],
"documentation":"<p>Creates a new snapshot schedule.</p>"
"documentation":"<p>Creates a snapshot schedule with the rate of every 12 hours.</p>"
},
"CreateTags":{
"name":"CreateTags",
@ -403,7 +403,7 @@
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidTagFault"}
],
"documentation":"<p>Adds one or more tags to a specified resource.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.</p> <p>If you specify a key that already exists for the resource, the value for that key will be updated with the new value.</p>"
"documentation":"<p>Adds tags to a cluster.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.</p> <p>If you specify a key that already exists for the resource, the value for that key will be updated with the new value.</p>"
},
"DeleteCluster":{
"name":"DeleteCluster",
@ -423,7 +423,7 @@
{"shape":"ClusterSnapshotQuotaExceededFault"},
{"shape":"InvalidRetentionPeriodFault"}
],
"documentation":"<p>Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster. </p> <p> For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
"documentation":"<p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use <a>DescribeClusters</a> to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you want to shut down the cluster and retain it for future use, set <i>SkipFinalClusterSnapshot</i> to <code>false</code> and specify a name for <i>FinalClusterSnapshotIdentifier</i>. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster. </p> <p> For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"DeleteClusterParameterGroup":{
"name":"DeleteClusterParameterGroup",
@ -571,7 +571,7 @@
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidTagFault"}
],
"documentation":"<p>Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.</p>"
"documentation":"<p>Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.</p>"
},
"DescribeAccountAttributes":{
"name":"DescribeAccountAttributes",
@ -982,7 +982,7 @@
"shape":"CustomerStorageMessage",
"resultWrapper":"DescribeStorageResult"
},
"documentation":"<p>Returns the total amount of snapshot usage and provisioned storage in megabytes.</p>"
"documentation":"<p>Returns account level backups storage size and provisional storage.</p>"
},
"DescribeTableRestoreStatus":{
"name":"DescribeTableRestoreStatus",
@ -1169,7 +1169,7 @@
{"shape":"InvalidClusterTrackFault"},
{"shape":"InvalidRetentionPeriodFault"}
],
"documentation":"<p>Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p>"
"documentation":"<p>Modifies the settings for a cluster.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p> <p>You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
"ModifyClusterDbRevision":{
"name":"ModifyClusterDbRevision",
@ -1220,7 +1220,7 @@
"errors":[
{"shape":"ClusterNotFoundFault"}
],
"documentation":"<p>Modifies the maintenance settings of a cluster. For example, you can defer a maintenance window. You can also update or cancel a deferment. </p>"
"documentation":"<p>Modifies the maintenance settings of a cluster.</p>"
},
"ModifyClusterParameterGroup":{
"name":"ModifyClusterParameterGroup",
@ -1255,7 +1255,7 @@
{"shape":"ClusterSnapshotNotFoundFault"},
{"shape":"InvalidRetentionPeriodFault"}
],
"documentation":"<p>Modifies the settings for a snapshot.</p>"
"documentation":"<p>Modifies the settings for a snapshot.</p> <p>This exanmple modifies the manual retention period setting for a cluster snapshot.</p>"
},
"ModifyClusterSnapshotSchedule":{
"name":"ModifyClusterSnapshotSchedule",
@ -1334,7 +1334,7 @@
{"shape":"InvalidScheduledActionFault"},
{"shape":"UnauthorizedOperation"}
],
"documentation":"<p>Modify a scheduled action. </p>"
"documentation":"<p>Modifies a scheduled action. </p>"
},
"ModifySnapshotCopyRetentionPeriod":{
"name":"ModifySnapshotCopyRetentionPeriod",
@ -1449,7 +1449,7 @@
{"shape":"UnauthorizedOperation"},
{"shape":"LimitExceededFault"}
],
"documentation":"<p>Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. </p> <p>Elastic resize operations have the following restrictions:</p> <ul> <li> <p>You can only resize clusters of the following types:</p> <ul> <li> <p>dc2.large</p> </li> <li> <p>dc2.8xlarge</p> </li> <li> <p>ds2.xlarge</p> </li> <li> <p>ds2.8xlarge</p> </li> </ul> </li> <li> <p>The type of nodes that you add must match the node type for the cluster.</p> </li> </ul>"
"documentation":"<p>Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. </p> <p>Elastic resize operations have the following restrictions:</p> <ul> <li> <p>You can only resize clusters of the following types:</p> <ul> <li> <p>dc2.large</p> </li> <li> <p>dc2.8xlarge</p> </li> <li> <p>ds2.xlarge</p> </li> <li> <p>ds2.8xlarge</p> </li> <li> <p>ra3.16xlarge</p> </li> </ul> </li> <li> <p>The type of nodes that you add must match the node type for the cluster.</p> </li> </ul>"
},
"RestoreFromClusterSnapshot":{
"name":"RestoreFromClusterSnapshot",
@ -2828,7 +2828,7 @@
},
"NodeType":{
"shape":"String",
"documentation":"<p>The node type to be provisioned for the cluster. For information about node types, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes\"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p> <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code> | <code>dc2.large</code> | <code>dc2.8xlarge</code> </p>"
"documentation":"<p>The node type to be provisioned for the cluster. For information about node types, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes\"> Working with Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p> <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code> | <code>dc2.large</code> | <code>dc2.8xlarge</code> | <code>ra3.16xlarge</code> </p>"
},
"MasterUsername":{
"shape":"String",
@ -2852,7 +2852,7 @@
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.</p> <p>Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.</p> <p>Example: <code>us-east-1d</code> </p> <p>Constraint: The specified Availability Zone must be in the same region as the current endpoint.</p>"
"documentation":"<p>The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.</p> <p>Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.</p> <p>Example: <code>us-east-2d</code> </p> <p>Constraint: The specified Availability Zone must be in the same region as the current endpoint.</p>"
},
"PreferredMaintenanceWindow":{
"shape":"String",
@ -3086,7 +3086,7 @@
},
"SourceType":{
"shape":"String",
"documentation":"<p>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.</p> <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.</p>"
"documentation":"<p>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.</p> <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.</p>"
},
"SourceIds":{
"shape":"SourceIdsList",
@ -3292,7 +3292,7 @@
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>"
},
"Tags":{
"shape":"TagList",
@ -3558,7 +3558,7 @@
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>"
},
"TagKeys":{
"shape":"TagKeyList",
@ -3867,7 +3867,7 @@
"members":{
"SourceType":{
"shape":"String",
"documentation":"<p>The source type, such as cluster or parameter group, to which the described event categories apply.</p> <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.</p>"
"documentation":"<p>The source type, such as cluster or parameter group, to which the described event categories apply.</p> <p>Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.</p>"
}
},
"documentation":"<p/>"
@ -4231,7 +4231,7 @@
"members":{
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>. </p>"
},
"ResourceType":{
"shape":"String",
@ -4543,7 +4543,7 @@
},
"SourceType":{
"shape":"String",
"documentation":"<p>The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.</p>"
"documentation":"<p>The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action. </p>"
},
"SourceIdsList":{
"shape":"SourceIdsList",
@ -5409,11 +5409,11 @@
},
"NodeType":{
"shape":"String",
"documentation":"<p>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.</p> <p>When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. </p> <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code> | <code>dc2.large</code> | <code>dc2.8xlarge</code> </p>"
"documentation":"<p>The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.</p> <p> For more information about resizing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html\">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: <code>ds2.xlarge</code> | <code>ds2.8xlarge</code> | <code>dc1.large</code> | <code>dc1.8xlarge</code> | <code>dc2.large</code> | <code>dc2.8xlarge</code> | <code>ra3.16xlarge</code> </p>"
},
"NumberOfNodes":{
"shape":"IntegerOptional",
"documentation":"<p>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.</p> <p>When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use <a>DescribeResize</a> to track the progress of the resize request. </p> <p>Valid Values: Integer greater than <code>0</code>.</p>"
"documentation":"<p>The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.</p> <p> For more information about resizing clusters, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html\">Resizing Clusters in Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>Valid Values: Integer greater than <code>0</code>.</p>"
},
"ClusterSecurityGroups":{
"shape":"ClusterSecurityGroupNameList",
@ -5481,7 +5481,7 @@
},
"Encrypted":{
"shape":"BooleanOptional",
"documentation":"<p>Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the <code>KmsKeyId</code> parameter, we will encrypt the cluster with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.</p>"
"documentation":"<p>Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the <code>KmsKeyId</code> parameter, we encrypt the cluster with the provided <code>KmsKeyId</code>. If you don't provide a <code>KmsKeyId</code>, we encrypt with the default key. In the China region we use legacy encryption if you specify that the cluster is encrypted.</p> <p>If the value is not encrypted (false), then the cluster is decrypted. </p>"
},
"KmsKeyId":{
"shape":"String",
@ -5598,7 +5598,7 @@
},
"SourceType":{
"shape":"String",
"documentation":"<p>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.</p> <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.</p>"
"documentation":"<p>The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.</p> <p>Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.</p>"
},
"SourceIds":{
"shape":"SourceIdsList",
@ -6447,7 +6447,7 @@
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>The Amazon EC2 Availability Zone in which to restore the cluster.</p> <p>Default: A random, system-chosen Availability Zone.</p> <p>Example: <code>us-east-1a</code> </p>"
"documentation":"<p>The Amazon EC2 Availability Zone in which to restore the cluster.</p> <p>Default: A random, system-chosen Availability Zone.</p> <p>Example: <code>us-east-2a</code> </p>"
},
"AllowVersionUpgrade":{
"shape":"BooleanOptional",
@ -7737,7 +7737,7 @@
},
"ResourceName":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) with which the tag is associated, for example: <code>arn:aws:redshift:us-east-1:123456789:cluster:t1</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) with which the tag is associated, for example: <code>arn:aws:redshift:us-east-2:123456789:cluster:t1</code>.</p>"
},
"ResourceType":{
"shape":"String",

File diff suppressed because one or more lines are too long

View file

@ -35,6 +35,12 @@
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "simulationJobSummaries"
},
"ListSimulationJobBatches": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "simulationJobBatchSummaries"
}
}
}

View file

@ -61,6 +61,22 @@
],
"documentation":"<p>Cancels the specified simulation job.</p>"
},
"CancelSimulationJobBatch":{
"name":"CancelSimulationJobBatch",
"http":{
"method":"POST",
"requestUri":"/cancelSimulationJobBatch"
},
"input":{"shape":"CancelSimulationJobBatchRequest"},
"output":{"shape":"CancelSimulationJobBatchResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch. </p>"
},
"CreateDeploymentJob":{
"name":"CreateDeploymentJob",
"http":{
@ -374,6 +390,21 @@
],
"documentation":"<p>Describes a simulation job.</p>"
},
"DescribeSimulationJobBatch":{
"name":"DescribeSimulationJobBatch",
"http":{
"method":"POST",
"requestUri":"/describeSimulationJobBatch"
},
"input":{"shape":"DescribeSimulationJobBatchRequest"},
"output":{"shape":"DescribeSimulationJobBatchResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Describes a simulation job batch.</p>"
},
"ListDeploymentJobs":{
"name":"ListDeploymentJobs",
"http":{
@ -388,7 +419,7 @@
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. </p> <note> <p> </p> </note>"
"documentation":"<p>Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. </p>"
},
"ListFleets":{
"name":"ListFleets",
@ -452,6 +483,20 @@
],
"documentation":"<p>Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. </p>"
},
"ListSimulationJobBatches":{
"name":"ListSimulationJobBatches",
"http":{
"method":"POST",
"requestUri":"/listSimulationJobBatches"
},
"input":{"shape":"ListSimulationJobBatchesRequest"},
"output":{"shape":"ListSimulationJobBatchesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. </p>"
},
"ListSimulationJobs":{
"name":"ListSimulationJobs",
"http":{
@ -517,6 +562,23 @@
],
"documentation":"<p>Restarts a running simulation job.</p>"
},
"StartSimulationJobBatch":{
"name":"StartSimulationJobBatch",
"http":{
"method":"POST",
"requestUri":"/startSimulationJobBatch"
},
"input":{"shape":"StartSimulationJobBatchRequest"},
"output":{"shape":"StartSimulationJobBatchResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"IdempotentParameterMismatchException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts a new simulation job batch. The batch is defined using one or more <code>SimulationJobRequest</code> objects. </p>"
},
"SyncDeploymentJob":{
"name":"SyncDeploymentJob",
"http":{
@ -647,6 +709,21 @@
}
}
},
"BatchPolicy":{
"type":"structure",
"members":{
"timeoutInSeconds":{
"shape":"BatchTimeoutInSeconds",
"documentation":"<p>The amount of time, in seconds, to wait for the batch to complete. </p> <p>If a batch times out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), they will be moved to the failed list and the batch status will be <code>Failed</code>. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be <code>TimedOut</code>. </p>"
},
"maxConcurrency":{
"shape":"MaxConcurrency",
"documentation":"<p>The number of active simulation jobs create as part of the batch that can be in an active state at the same time. </p> <p>Active states include: <code>Pending</code>,<code>Preparing</code>, <code>Running</code>, <code>Restarting</code>, <code>RunningFailed</code> and <code>Terminating</code>. All other states are terminal states. </p>"
}
},
"documentation":"<p>Information about the batch policy.</p>"
},
"BatchTimeoutInSeconds":{"type":"long"},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{"type":"boolean"},
"CancelDeploymentJobRequest":{
@ -664,6 +741,21 @@
"members":{
}
},
"CancelSimulationJobBatchRequest":{
"type":"structure",
"required":["batch"],
"members":{
"batch":{
"shape":"Arn",
"documentation":"<p>The id of the batch to cancel.</p>"
}
}
},
"CancelSimulationJobBatchResponse":{
"type":"structure",
"members":{
}
},
"CancelSimulationJobRequest":{
"type":"structure",
"required":["job"],
@ -825,7 +917,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribuition) used by the robot application.</p>"
},
"tags":{
"shape":"TagMap",
@ -854,7 +946,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the robot application.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
@ -905,7 +997,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the robot application.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
@ -995,7 +1087,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite of the simulation application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the simulation application.</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",
@ -1032,7 +1124,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about the robot software suite.</p>"
"documentation":"<p>Information about the robot software suite (ROS distribution).</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",
@ -1091,7 +1183,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about the robot software suite.</p>"
"documentation":"<p>Information about the robot software suite (ROS distribution).</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",
@ -1149,7 +1241,7 @@
},
"dataSources":{
"shape":"DataSourceConfigs",
"documentation":"<p>The data sources for the simulation job.</p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
"documentation":"<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
},
"tags":{
"shape":"TagMap",
@ -1161,6 +1253,11 @@
}
}
},
"CreateSimulationJobRequests":{
"type":"list",
"member":{"shape":"SimulationJobRequest"},
"min":1
},
"CreateSimulationJobResponse":{
"type":"structure",
"members":{
@ -1691,7 +1788,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the robot application.</p>"
},
"revisionId":{
"shape":"RevisionId",
@ -1801,7 +1898,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about the robot software suite.</p>"
"documentation":"<p>Information about the robot software suite (ROS distribution).</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",
@ -1821,6 +1918,69 @@
}
}
},
"DescribeSimulationJobBatchRequest":{
"type":"structure",
"required":["batch"],
"members":{
"batch":{
"shape":"Arn",
"documentation":"<p>The id of the batch to describe.</p>"
}
}
},
"DescribeSimulationJobBatchResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the batch.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was last updated.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"failureCode":{
"shape":"SimulationJobBatchErrorCode",
"documentation":"<p>The failure code of the simulation job batch.</p>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason the simulation job batch failed.</p>"
},
"failedRequests":{
"shape":"FailedCreateSimulationJobRequests",
"documentation":"<p>A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. </p>"
},
"pendingRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>"
},
"createdRequests":{
"shape":"SimulationJobSummaries",
"documentation":"<p>A list of created simulation job summaries.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job batch.</p>"
}
}
},
"DescribeSimulationJobRequest":{
"type":"structure",
"required":["job"],
@ -1935,6 +2095,33 @@
"min":1,
"pattern":".*"
},
"FailedAt":{"type":"timestamp"},
"FailedCreateSimulationJobRequest":{
"type":"structure",
"members":{
"request":{
"shape":"SimulationJobRequest",
"documentation":"<p>The simulation job request.</p>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The failure reason of the simulation job request.</p>"
},
"failureCode":{
"shape":"SimulationJobErrorCode",
"documentation":"<p>The failure code.</p>"
},
"failedAt":{
"shape":"FailedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch failed.</p>"
}
},
"documentation":"<p>Information about a failed create simulation job request.</p>"
},
"FailedCreateSimulationJobRequests":{
"type":"list",
"member":{"shape":"FailedCreateSimulationJobRequest"}
},
"FailureBehavior":{
"type":"string",
"enum":[
@ -2027,6 +2214,7 @@
"error":{"httpStatusCode":400},
"exception":true
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
@ -2092,11 +2280,11 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListDeploymentJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>"
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListDeploymentJobs</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>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListDeploymentJobs</code> in paginated output. When this parameter is used, <code>ListDeploymentJobs</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>ListDeploymentJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListDeploymentJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListDeploymentJobs</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>ListDeploymentJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 200. If this parameter is not used, then <code>ListDeploymentJobs</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
}
}
},
@ -2122,7 +2310,7 @@
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListFleets</code> in paginated output. When this parameter is used, <code>ListFleets</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>ListFleets</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListFleets</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListFleets</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>ListFleets</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 200. If this parameter is not used, then <code>ListFleets</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
},
"filters":{
"shape":"Filters",
@ -2152,11 +2340,11 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRobotApplications</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>"
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRobotApplications</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>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListRobotApplications</code> in paginated output. When this parameter is used, <code>ListRobotApplications</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>ListRobotApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRobotApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListRobotApplications</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>ListRobotApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRobotApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
},
"filters":{
"shape":"Filters",
@ -2182,11 +2370,11 @@
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRobots</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>"
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListRobots</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>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListRobots</code> in paginated output. When this parameter is used, <code>ListRobots</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>ListRobots</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListRobots</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListRobots</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>ListRobots</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 200. If this parameter is not used, then <code>ListRobots</code> returns up to 200 results and a <code>nextToken</code> value if applicable. </p>"
},
"filters":{
"shape":"Filters",
@ -2216,11 +2404,11 @@
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationApplications</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>"
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationApplications</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>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListSimulationApplications</code> in paginated output. When this parameter is used, <code>ListSimulationApplications</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>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListSimulationApplications</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>ListSimulationApplications</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationApplications</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
},
"filters":{
"shape":"Filters",
@ -2241,6 +2429,36 @@
}
}
},
"ListSimulationJobBatchesRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListSimulationJobBatches</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>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>When this parameter is used, <code>ListSimulationJobBatches</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>ListSimulationJobBatches</code> request with the returned <code>nextToken</code> value. </p>"
},
"filters":{
"shape":"Filters",
"documentation":"<p>Optional filters to limit results.</p>"
}
}
},
"ListSimulationJobBatchesResponse":{
"type":"structure",
"members":{
"simulationJobBatchSummaries":{
"shape":"SimulationJobBatchSummaries",
"documentation":"<p>A list of simulation job batch summaries.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListSimulationJobBatches</code> request. When the results of a <code>ListSimulationJobBatches</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>"
}
}
},
"ListSimulationJobsRequest":{
"type":"structure",
"members":{
@ -2250,7 +2468,7 @@
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of deployment job results returned by <code>ListSimulationJobs</code> in paginated output. When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListSimulationJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>"
"documentation":"<p>When this parameter is used, <code>ListSimulationJobs</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>ListSimulationJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListSimulationJobs</code> returns up to 1000 results and a <code>nextToken</code> value if applicable. </p>"
},
"filters":{
"shape":"Filters",
@ -2304,6 +2522,7 @@
},
"documentation":"<p>The logging configuration.</p>"
},
"MaxConcurrency":{"type":"integer"},
"MaxResults":{"type":"integer"},
"Name":{
"type":"string",
@ -2331,6 +2550,7 @@
},
"NonEmptyString":{
"type":"string",
"max":255,
"min":1
},
"NonSystemPort":{
@ -2631,7 +2851,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about a robot software suite.</p>"
"documentation":"<p>Information about a robot software suite (ROS distribution).</p>"
}
},
"documentation":"<p>Summary information for a robot application.</p>"
@ -2691,14 +2911,14 @@
"members":{
"name":{
"shape":"RobotSoftwareSuiteType",
"documentation":"<p>The name of the robot software suite.</p>"
"documentation":"<p>The name of the robot software suite (ROS distribution).</p>"
},
"version":{
"shape":"RobotSoftwareSuiteVersionType",
"documentation":"<p>The version of the robot software suite.</p>"
"documentation":"<p>The version of the robot software suite (ROS distribution).</p>"
}
},
"documentation":"<p>Information about a robot software suite.</p>"
"documentation":"<p>Information about a robot software suite (ROS distribution).</p>"
},
"RobotSoftwareSuiteType":{
"type":"string",
@ -2866,7 +3086,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about a robot software suite.</p>"
"documentation":"<p>Information about a robot software suite (ROS distribution).</p>"
},
"simulationSoftwareSuite":{
"shape":"SimulationSoftwareSuite",
@ -2961,6 +3181,62 @@
},
"documentation":"<p>Information about a simulation job.</p>"
},
"SimulationJobBatchErrorCode":{
"type":"string",
"enum":["InternalServiceError"]
},
"SimulationJobBatchStatus":{
"type":"string",
"enum":[
"Pending",
"InProgress",
"Failed",
"Completed",
"Canceled",
"Canceling",
"Completing",
"TimingOut",
"TimedOut"
]
},
"SimulationJobBatchSummaries":{
"type":"list",
"member":{"shape":"SimulationJobBatchSummary"}
},
"SimulationJobBatchSummary":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the batch.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was last updated.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the simulation job batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"failedRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of failed simulation job requests.</p>"
},
"pendingRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of pending simulation job requests.</p>"
},
"createdRequestCount":{
"shape":"Integer",
"documentation":"<p>The number of created simulation job requests.</p>"
}
},
"documentation":"<p>Information about a simulation job batch.</p>"
},
"SimulationJobErrorCode":{
"type":"string",
"enum":[
@ -2978,10 +3254,14 @@
"InvalidBundleRobotApplication",
"InvalidBundleSimulationApplication",
"InvalidS3Resource",
"LimitExceeded",
"MismatchedEtag",
"RobotApplicationVersionMismatchedEtag",
"SimulationApplicationVersionMismatchedEtag",
"ResourceNotFound",
"RequestThrottled",
"BatchTimedOut",
"BatchCanceled",
"InvalidInput",
"WrongRegionS3Bucket",
"WrongRegionS3Output",
@ -2989,6 +3269,48 @@
"WrongRegionSimulationApplication"
]
},
"SimulationJobRequest":{
"type":"structure",
"required":["maxJobDurationInSeconds"],
"members":{
"outputLocation":{"shape":"OutputLocation"},
"loggingConfig":{"shape":"LoggingConfig"},
"maxJobDurationInSeconds":{
"shape":"JobDuration",
"documentation":"<p>The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.</p>"
},
"iamRole":{
"shape":"IamRole",
"documentation":"<p>The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. </p>"
},
"failureBehavior":{
"shape":"FailureBehavior",
"documentation":"<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Restart the simulation job in the same host instance.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>"
},
"useDefaultApplications":{
"shape":"BoxedBoolean",
"documentation":"<p>Boolean indicating whether to use default simulation tool applications.</p>"
},
"robotApplications":{
"shape":"RobotApplicationConfigs",
"documentation":"<p>The robot applications to use in the simulation job.</p>"
},
"simulationApplications":{
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation applications to use in the simulation job.</p>"
},
"dataSources":{
"shape":"DataSourceConfigs",
"documentation":"<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
},
"vpcConfig":{"shape":"VPCConfig"},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job request.</p>"
}
},
"documentation":"<p>Information about a simulation job request.</p>"
},
"SimulationJobStatus":{
"type":"string",
"enum":[
@ -3122,6 +3444,77 @@
"type":"list",
"member":{"shape":"Source"}
},
"StartSimulationJobBatchRequest":{
"type":"structure",
"required":["createSimulationJobRequests"],
"members":{
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"createSimulationJobRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of simulation job requests to create in the batch.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the deployment job batch.</p>"
}
}
},
"StartSimulationJobBatchResponse":{
"type":"structure",
"members":{
"arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (arn) of the batch.</p>"
},
"status":{
"shape":"SimulationJobBatchStatus",
"documentation":"<p>The status of the simulation job batch.</p> <dl> <dt>Pending</dt> <dd> <p>The simulation job batch request is pending.</p> </dd> <dt>InProgress</dt> <dd> <p>The simulation job batch is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like <code>InternalServiceError</code>). See <code>failureCode</code> and <code>failureReason</code> for more information.</p> </dd> <dt>Completed</dt> <dd> <p>The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to <code>InternalServiceError</code> and (2) when all created simulation jobs have reached a terminal state (for example, <code>Completed</code> or <code>Failed</code>). </p> </dd> <dt>Canceled</dt> <dd> <p>The simulation batch job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The simulation batch job is being cancelled.</p> </dd> <dt>Completing</dt> <dd> <p>The simulation batch job is completing.</p> </dd> <dt>TimingOut</dt> <dd> <p>The simulation job batch is timing out.</p> <p>If a batch timing out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), the batch status will be <code>Failed</code>. If there are no such failing request, the batch status will be <code>TimedOut</code>. </p> </dd> <dt>TimedOut</dt> <dd> <p>The simulation batch job timed out.</p> </dd> </dl>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
},
"batchPolicy":{
"shape":"BatchPolicy",
"documentation":"<p>The batch policy.</p>"
},
"failureCode":{
"shape":"SimulationJobBatchErrorCode",
"documentation":"<p>The failure code if the simulation job batch failed.</p>"
},
"failureReason":{
"shape":"GenericString",
"documentation":"<p>The reason the simulation job batch failed.</p>"
},
"failedRequests":{
"shape":"FailedCreateSimulationJobRequests",
"documentation":"<p>A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. </p>"
},
"pendingRequests":{
"shape":"CreateSimulationJobRequests",
"documentation":"<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>"
},
"createdRequests":{
"shape":"SimulationJobSummaries",
"documentation":"<p>A list of created simulation job request summaries.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the deployment job batch.</p>"
}
}
},
"Subnets":{
"type":"list",
"member":{"shape":"NonEmptyString"},
@ -3283,7 +3676,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the robot application.</p>"
},
"currentRevisionId":{
"shape":"RevisionId",
@ -3312,7 +3705,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>The robot software suite used by the robot application.</p>"
"documentation":"<p>The robot software suite (ROS distribution) used by the robot application.</p>"
},
"lastUpdatedAt":{
"shape":"LastUpdatedAt",
@ -3347,7 +3740,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about the robot software suite.</p>"
"documentation":"<p>Information about the robot software suite (ROS distribution).</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",
@ -3384,7 +3777,7 @@
},
"robotSoftwareSuite":{
"shape":"RobotSoftwareSuite",
"documentation":"<p>Information about the robot software suite.</p>"
"documentation":"<p>Information about the robot software suite (ROS distribution).</p>"
},
"renderingEngine":{
"shape":"RenderingEngine",

File diff suppressed because one or more lines are too long

View file

@ -280,6 +280,9 @@
},
"input":{"shape":"CreatePresignedDomainUrlRequest"},
"output":{"shape":"CreatePresignedDomainUrlResponse"},
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Amazon SageMaker Studio (Studio), and granted access to all of the Apps and files associated with that Amazon Elastic File System (EFS). This operation can only be called when AuthMode equals IAM. </p>"
},
"CreatePresignedNotebookInstanceUrl":{
@ -362,7 +365,7 @@
"errors":[
{"shape":"ResourceLimitExceeded"}
],
"documentation":"<p>Creates a <i>trial component</i>, which is a stage of a machine learning <i>trial</i>. A trial is composed of one or more trial components. A trial component can be used in multiple trials.</p> <p>Trial components include pre-processing jobs, training jobs, and batch transform jobs.</p> <p>When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.</p> <p>You can add tags to a trial component and then use the <a>Search</a> API to search for the tags.</p> <note> <p>You can create a trial component through a direct call to the <code>CreateTrialComponent</code> API. However, you can't specify the <code>Source</code> property of the component in the request, therefore, the component isn't associated with an Amazon SageMaker job. You must use Amazon SageMaker Studio, the Amazon SageMaker Python SDK, or the AWS SDK for Python (Boto) to create the component with a valid <code>Source</code> property.</p> </note>"
"documentation":"<p>Creates a <i>trial component</i>, which is a stage of a machine learning <i>trial</i>. A trial is composed of one or more trial components. A trial component can be used in multiple trials.</p> <p>Trial components include pre-processing jobs, training jobs, and batch transform jobs.</p> <p>When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.</p> <p>You can add tags to a trial component and then use the <a>Search</a> API to search for the tags.</p> <note> <p> <code>CreateTrialComponent</code> can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to <code>CreateTrialComponent</code> from outside one of these environments results in an error.</p> </note>"
},
"CreateUserProfile":{
"name":"CreateUserProfile",
@ -888,6 +891,16 @@
],
"documentation":"<p>Describes the user profile.</p>"
},
"DescribeWorkforce":{
"name":"DescribeWorkforce",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkforceRequest"},
"output":{"shape":"DescribeWorkforceResponse"},
"documentation":"<p>Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (<a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>). Allowable IP address ranges are the IP addresses that workers can use to access tasks. </p> <important> <p>This operation applies only to private workforces.</p> </important>"
},
"DescribeWorkteam":{
"name":"DescribeWorkteam",
"http":{
@ -1208,7 +1221,10 @@
},
"input":{"shape":"ListTrialComponentsRequest"},
"output":{"shape":"ListTrialComponentsResponse"},
"documentation":"<p>Lists the trial components in your account. You can filter the list to show only components that were created in a specific time range. You can sort the list by trial component name or creation time.</p>"
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:</p> <ul> <li> <p> <code>ExperimentName</code> </p> </li> <li> <p> <code>SourceArn</code> </p> </li> <li> <p> <code>TrialName</code> </p> </li> </ul>"
},
"ListTrials":{
"name":"ListTrials",
@ -1218,6 +1234,9 @@
},
"input":{"shape":"ListTrialsRequest"},
"output":{"shape":"ListTrialsResponse"},
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.</p>"
},
"ListUserProfiles":{
@ -1258,7 +1277,7 @@
},
"input":{"shape":"SearchRequest"},
"output":{"shape":"SearchResponse"},
"documentation":"<p>Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of <code>SearchResult</code> objects in the response. You can sort the search results by any resource property in a ascending or descending order.</p> <p>You can query against the following value types: numerical, text, Booleans, and timestamps.</p>"
"documentation":"<p>Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of <code>SearchResult</code> objects in the response. You can sort the search results by any resource property in a ascending or descending order.</p> <p>You can query against the following value types: numeric, text, Boolean, and timestamp.</p>"
},
"StartMonitoringSchedule":{
"name":"StartMonitoringSchedule",
@ -1537,6 +1556,16 @@
],
"documentation":"<p>Updates a user profile.</p>"
},
"UpdateWorkforce":{
"name":"UpdateWorkforce",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWorkforceRequest"},
"output":{"shape":"UpdateWorkforceResponse"},
"documentation":"<p>Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to four <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>.</p> <p>By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied access and get a <code>Not Found</code> error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the operation.</p> <important> <p>This operation applies only to private workforces.</p> </important>"
},
"UpdateWorkteam":{
"name":"UpdateWorkteam",
"http":{
@ -1632,7 +1661,7 @@
},
"EnableSageMakerMetricsTimeSeries":{
"shape":"Boolean",
"documentation":"<p>To generate and save time-series metrics during training, set to <code>true</code>. The default is <code>false</code> and time-series metrics aren't generated except in the following cases:</p> <ul> <li> <p>You use one of the Amazon SageMaker built-in algorithms</p> </li> <li> <p>You use one of the following prebuilt Amazon SageMaker Docker images:</p> <ul> <li> <p>Tensorflow</p> </li> <li> <p>MXNet</p> </li> <li> <p>PyTorch</p> </li> </ul> </li> <li> <p>You specify at least one <a>MetricDefinition</a> </p> </li> </ul>"
"documentation":"<p>To generate and save time-series metrics during training, set to <code>true</code>. The default is <code>false</code> and time-series metrics aren't generated except in the following cases:</p> <ul> <li> <p>You use one of the Amazon SageMaker built-in algorithms</p> </li> <li> <p>You use one of the following <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html\">Prebuilt Amazon SageMaker Docker Images</a>:</p> <ul> <li> <p>Tensorflow (version &gt;= 1.15)</p> </li> <li> <p>MXNet (version &gt;= 1.6)</p> </li> <li> <p>PyTorch (version &gt;= 1.3)</p> </li> </ul> </li> <li> <p>You specify at least one <a>MetricDefinition</a> </p> </li> </ul>"
}
},
"documentation":"<p>Specifies the training algorithm to use in a <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html\">CreateTrainingJob</a> request.</p> <p>For more information about algorithms provided by Amazon SageMaker, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html\">Algorithms</a>. For information about using your own algorithms, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html\">Using Your Own Algorithms with Amazon SageMaker</a>. </p>"
@ -2622,6 +2651,16 @@
},
"documentation":"<p>Contains information about the output location for managed spot training checkpoint data. </p>"
},
"Cidr":{
"type":"string",
"max":64,
"min":4,
"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])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$)|(^s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\/(12[0-8]|1[0-1][0-9]|[1-9][0-9]|[0-9]))$)"
},
"Cidrs":{
"type":"list",
"member":{"shape":"Cidr"}
},
"CodeRepositoryArn":{
"type":"string",
"max":2048,
@ -2741,7 +2780,7 @@
"members":{
"CollectionName":{
"shape":"CollectionName",
"documentation":"<p>The name of the tensor collection.</p>"
"documentation":"<p>The name of the tensor collection. The name must be unique relative to other rule configuration names.</p>"
},
"CollectionParameters":{
"shape":"CollectionParameters",
@ -3293,7 +3332,7 @@
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.</p> <note> <p>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <code>KmsKeyId</code> when using an instance type with local storage. If any of the models that you specify in the <code>ProductionVariants</code> parameter use nitro-based instances with local storage, do not specify a value for the <code>KmsKeyId</code> parameter. If you specify a value for <code>KmsKeyId</code> when using any nitro-based instances with local storage, the call to <code>CreateEndpointConfig</code> fails.</p> <p>For a list of instance types that support local instance storage, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes\">Instance Store Volumes</a>.</p> <p>For more information about local instance storage encryption, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html\">SSD Instance Store Volumes</a>.</p> </note>"
"documentation":"<p>The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.</p> <p>The KmsKeyId can be any of the following formats: </p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>The KMS key policy must grant permission to the IAM role that you specify in your <code>CreateEndpoint</code>, <code>UpdateEndpoint</code> requests. For more information, refer to the AWS Key Management Service section<a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\"> Using Key Policies in AWS KMS </a> </p> <note> <p>Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a <code>KmsKeyId</code> when using an instance type with local storage. If any of the models that you specify in the <code>ProductionVariants</code> parameter use nitro-based instances with local storage, do not specify a value for the <code>KmsKeyId</code> parameter. If you specify a value for <code>KmsKeyId</code> when using any nitro-based instances with local storage, the call to <code>CreateEndpointConfig</code> fails.</p> <p>For a list of instance types that support local instance storage, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes\">Instance Store Volumes</a>.</p> <p>For more information about local instance storage encryption, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html\">SSD Instance Store Volumes</a>.</p> </note>"
}
}
},
@ -3581,7 +3620,7 @@
},
"EnableNetworkIsolation":{
"shape":"Boolean",
"documentation":"<p>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</p> <note> <p>The Semantic Segmentation built-in algorithm does not support network isolation.</p> </note>"
"documentation":"<p>Isolates the model container. No inbound or outbound network calls can be made to or from the model container.</p>"
}
}
},
@ -3936,7 +3975,7 @@
},
"EnableNetworkIsolation":{
"shape":"Boolean",
"documentation":"<p>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p> <note> <p>The Semantic Segmentation built-in algorithm does not support network isolation.</p> </note>"
"documentation":"<p>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p>"
},
"EnableInterContainerTrafficEncryption":{
"shape":"Boolean",
@ -4360,7 +4399,7 @@
},
"LocalPath":{
"shape":"DirectoryPath",
"documentation":"<p>Path to local storage location for rules. Defaults to <code>/opt/ml/processing/output/rule/</code>.</p>"
"documentation":"<p>Path to local storage location for output of rules. Defaults to <code>/opt/ml/processing/output/rule/</code>.</p>"
},
"S3OutputPath":{
"shape":"S3Uri",
@ -4376,7 +4415,7 @@
},
"VolumeSizeInGB":{
"shape":"OptionalVolumeSizeInGB",
"documentation":"<p>The size, in GB, of the ML storage volume attached to the notebook instance.</p>"
"documentation":"<p>The size, in GB, of the ML storage volume attached to the processing instance.</p>"
},
"RuleParameters":{
"shape":"RuleParameters",
@ -5620,7 +5659,7 @@
},
"EnableNetworkIsolation":{
"shape":"Boolean",
"documentation":"<p>If <code>True</code>, no inbound or outbound network calls can be made to or from the model container.</p> <note> <p>The Semantic Segmentation built-in algorithm does not support network isolation.</p> </note>"
"documentation":"<p>If <code>True</code>, no inbound or outbound network calls can be made to or from the model container.</p>"
}
}
},
@ -6124,7 +6163,7 @@
},
"EnableNetworkIsolation":{
"shape":"Boolean",
"documentation":"<p>If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose <code>True</code>. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p> <note> <p>The Semantic Segmentation built-in algorithm does not support network isolation.</p> </note>"
"documentation":"<p>If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose <code>True</code>. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p>"
},
"EnableInterContainerTrafficEncryption":{
"shape":"Boolean",
@ -6442,6 +6481,26 @@
}
}
},
"DescribeWorkforceRequest":{
"type":"structure",
"required":["WorkforceName"],
"members":{
"WorkforceName":{
"shape":"WorkforceName",
"documentation":"<p>The name of the private workforce whose access you want to restrict. <code>WorkforceName</code> is automatically set to <code>\"default\"</code> when a workforce is created and cannot be modified. </p>"
}
}
},
"DescribeWorkforceResponse":{
"type":"structure",
"required":["Workforce"],
"members":{
"Workforce":{
"shape":"Workforce",
"documentation":"<p>A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html\">Create a Private Workforce</a>.</p>"
}
}
},
"DescribeWorkteamRequest":{
"type":"structure",
"required":["WorkteamName"],
@ -7203,6 +7262,7 @@
"type":"string",
"enum":[
"TENSORFLOW",
"KERAS",
"MXNET",
"ONNX",
"PYTORCH",
@ -7216,7 +7276,7 @@
"members":{
"Resource":{
"shape":"ResourceType",
"documentation":"<p>The name of the Amazon SageMaker resource to Search for. The only valid <code>Resource</code> value is <code>TrainingJob</code>.</p>"
"documentation":"<p>The name of the Amazon SageMaker resource to Search for.</p>"
},
"SuggestionQuery":{
"shape":"SuggestionQuery",
@ -7287,7 +7347,7 @@
"jsonvalue":true
}
},
"documentation":"<p>Defines under what conditions SageMaker creates a human loop.</p>"
"documentation":"<p>Defines under what conditions SageMaker creates a human loop. Used within .</p>"
},
"HumanLoopActivationConfig":{
"type":"structure",
@ -7411,11 +7471,11 @@
},
"TaskAvailabilityLifetimeInSeconds":{
"shape":"TaskAvailabilityLifetimeInSeconds",
"documentation":"<p>The length of time that a task remains available for labeling by human workers. <b>If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200)</b>. For private and vendor workforces, the maximum is as listed.</p>"
"documentation":"<p>The length of time that a task remains available for labeling by human workers. <b>If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200)</b>. The default value is 864000 seconds (1 day). For private and vendor workforces, the maximum is as listed.</p>"
},
"MaxConcurrentTaskCount":{
"shape":"MaxConcurrentTaskCount",
"documentation":"<p>Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time.</p>"
"documentation":"<p>Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects.</p>"
},
"AnnotationConsolidationConfig":{
"shape":"AnnotationConsolidationConfig",
@ -7592,7 +7652,7 @@
},
"EnableNetworkIsolation":{
"shape":"Boolean",
"documentation":"<p>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p> <note> <p>The Semantic Segmentation built-in algorithm does not support network isolation.</p> </note>"
"documentation":"<p>Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.</p>"
},
"EnableInterContainerTrafficEncryption":{
"shape":"Boolean",
@ -7936,7 +7996,7 @@
},
"DataInputConfig":{
"shape":"DataInputConfig",
"documentation":"<p>Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are <a>InputConfig$Framework</a> specific. </p> <ul> <li> <p> <code>TensorFlow</code>: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</p> <ul> <li> <p>Examples for one input:</p> <ul> <li> <p>If using the console, <code>{\"input\":[1,1024,1024,3]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input\\\":[1,1024,1024,3]}</code> </p> </li> </ul> </li> <li> <p>Examples for two inputs:</p> <ul> <li> <p>If using the console, <code>{\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}</code> </p> </li> </ul> </li> </ul> </li> <li> <p> <code>MXNET/ONNX</code>: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</p> <ul> <li> <p>Examples for one input:</p> <ul> <li> <p>If using the console, <code>{\"data\":[1,3,1024,1024]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"data\\\":[1,3,1024,1024]}</code> </p> </li> </ul> </li> <li> <p>Examples for two inputs:</p> <ul> <li> <p>If using the console, <code>{\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} </code> </p> </li> <li> <p>If using the CLI, <code>{\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}</code> </p> </li> </ul> </li> </ul> </li> <li> <p> <code>PyTorch</code>: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.</p> <ul> <li> <p>Examples for one input in dictionary format:</p> <ul> <li> <p>If using the console, <code>{\"input0\":[1,3,224,224]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input0\\\":[1,3,224,224]}</code> </p> </li> </ul> </li> <li> <p>Example for one input in list format: <code>[[1,3,224,224]]</code> </p> </li> <li> <p>Examples for two inputs in dictionary format:</p> <ul> <li> <p>If using the console, <code>{\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]} </code> </p> </li> </ul> </li> <li> <p>Example for two inputs in list format: <code>[[1,3,224,224], [1,3,224,224]]</code> </p> </li> </ul> </li> <li> <p> <code>XGBOOST</code>: input data name and shape are not needed.</p> </li> </ul>"
"documentation":"<p>Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are <a>InputConfig$Framework</a> specific. </p> <ul> <li> <p> <code>TensorFlow</code>: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</p> <ul> <li> <p>Examples for one input:</p> <ul> <li> <p>If using the console, <code>{\"input\":[1,1024,1024,3]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input\\\":[1,1024,1024,3]}</code> </p> </li> </ul> </li> <li> <p>Examples for two inputs:</p> <ul> <li> <p>If using the console, <code>{\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}</code> </p> </li> </ul> </li> </ul> </li> <li> <p> <code>KERAS</code>: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, <code>DataInputConfig</code> should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.</p> <ul> <li> <p>Examples for one input:</p> <ul> <li> <p>If using the console, <code>{\"input_1\":[1,3,224,224]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input_1\\\":[1,3,224,224]}</code> </p> </li> </ul> </li> <li> <p>Examples for two inputs:</p> <ul> <li> <p>If using the console, <code>{\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]} </code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input_1\\\": [1,3,224,224], \\\"input_2\\\":[1,3,224,224]}</code> </p> </li> </ul> </li> </ul> </li> <li> <p> <code>MXNET/ONNX</code>: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.</p> <ul> <li> <p>Examples for one input:</p> <ul> <li> <p>If using the console, <code>{\"data\":[1,3,1024,1024]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"data\\\":[1,3,1024,1024]}</code> </p> </li> </ul> </li> <li> <p>Examples for two inputs:</p> <ul> <li> <p>If using the console, <code>{\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]} </code> </p> </li> <li> <p>If using the CLI, <code>{\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}</code> </p> </li> </ul> </li> </ul> </li> <li> <p> <code>PyTorch</code>: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.</p> <ul> <li> <p>Examples for one input in dictionary format:</p> <ul> <li> <p>If using the console, <code>{\"input0\":[1,3,224,224]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input0\\\":[1,3,224,224]}</code> </p> </li> </ul> </li> <li> <p>Example for one input in list format: <code>[[1,3,224,224]]</code> </p> </li> <li> <p>Examples for two inputs in dictionary format:</p> <ul> <li> <p>If using the console, <code>{\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}</code> </p> </li> <li> <p>If using the CLI, <code>{\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]} </code> </p> </li> </ul> </li> <li> <p>Example for two inputs in list format: <code>[[1,3,224,224], [1,3,224,224]]</code> </p> </li> </ul> </li> <li> <p> <code>XGBOOST</code>: input data name and shape are not needed.</p> </li> </ul>"
},
"Framework":{
"shape":"Framework",
@ -8900,7 +8960,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of experiments to return in the response.</p>"
"documentation":"<p>The maximum number of experiments to return in the response. The default value is 10.</p>"
}
}
},
@ -9821,9 +9881,17 @@
"ListTrialComponentsRequest":{
"type":"structure",
"members":{
"ExperimentName":{
"shape":"ExperimentEntityName",
"documentation":"<p>A filter that returns only components that are part of the specified experiment. If you specify <code>ExperimentName</code>, you can't filter by <code>SourceArn</code> or <code>TrialName</code>.</p>"
},
"TrialName":{
"shape":"ExperimentEntityName",
"documentation":"<p>A filter that returns only components that are part of the specified trial. If you specify <code>TrialName</code>, you can't filter by <code>ExperimentName</code> or <code>SourceArn</code>.</p>"
},
"SourceArn":{
"shape":"String256",
"documentation":"<p>A filter that returns only components that have the specified source Amazon Resource Name (ARN).</p>"
"documentation":"<p>A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify <code>SourceArn</code>, you can't filter by <code>ExperimentName</code> or <code>TrialName</code>.</p>"
},
"CreatedAfter":{
"shape":"Timestamp",
@ -9843,7 +9911,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of components to return in the response.</p>"
"documentation":"<p>The maximum number of components to return in the response. The default value is 10.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -9889,7 +9957,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of trials to return in the response.</p>"
"documentation":"<p>The maximum number of trials to return in the response. The default value is 10.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -10764,7 +10832,7 @@
"members":{
"NestedPropertyName":{
"shape":"ResourcePropertyName",
"documentation":"<p>The name of the property to use in the nested filters. The value must match a listed property name, such as <code>InputDataConfig</code> .</p>"
"documentation":"<p>The name of the property to use in the nested filters. The value must match a listed property name, such as <code>InputDataConfig</code>.</p>"
},
"Filters":{
"shape":"FilterList",
@ -11757,10 +11825,10 @@
"members":{
"PropertyNameHint":{
"shape":"PropertyNameHint",
"documentation":"<p>Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the <code>PropertyNameHint</code>.</p>"
"documentation":"<p>Text that begins a property's name.</p>"
}
},
"documentation":"<p>A type of <code>SuggestionQuery</code>. A suggestion query for retrieving property names that match the specified hint.</p>"
"documentation":"<p>Part of the <code>SuggestionQuery</code> type. Specifies a hint for retrieving property names that begin with the specified text.</p>"
},
"PropertyNameSuggestion":{
"type":"structure",
@ -12183,7 +12251,7 @@
"members":{
"Resource":{
"shape":"ResourceType",
"documentation":"<p>The name of the Amazon SageMaker resource to search for. Currently, the only valid <code>Resource</code> value is <code>TrainingJob</code>.</p>"
"documentation":"<p>The name of the Amazon SageMaker resource to search for.</p>"
},
"SearchExpression":{
"shape":"SearchExpression",
@ -12330,7 +12398,7 @@
"documentation":"<p>Determines the shuffling order in <code>ShuffleConfig</code> value.</p>"
}
},
"documentation":"<p>A configuration for a shuffle option for input data in a channel. If you use <code>S3Prefix</code> for <code>S3DataType</code>, the results of the S3 key prefix matches are shuffled. If you use <code>ManifestFile</code>, the order of the S3 object references in the <code>ManifestFile</code> is shuffled. If you use <code>AugmentedManifestFile</code>, the order of the JSON lines in the <code>AugmentedManifestFile</code> is shuffled. The shuffling order is determined using the <code>Seed</code> value.</p> <p>For Pipe input mode, shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when <code>ShuffleConfig</code> is combined with <code>S3DataDistributionType</code> of <code>ShardedByS3Key</code>, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.</p>"
"documentation":"<p>A configuration for a shuffle option for input data in a channel. If you use <code>S3Prefix</code> for <code>S3DataType</code>, the results of the S3 key prefix matches are shuffled. If you use <code>ManifestFile</code>, the order of the S3 object references in the <code>ManifestFile</code> is shuffled. If you use <code>AugmentedManifestFile</code>, the order of the JSON lines in the <code>AugmentedManifestFile</code> is shuffled. The shuffling order is determined using the <code>Seed</code> value.</p> <p>For Pipe input mode, when <code>ShuffleConfig</code> is specified shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when <code>ShuffleConfig</code> is combined with <code>S3DataDistributionType</code> of <code>ShardedByS3Key</code>, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.</p>"
},
"SingleSignOnUserIdentifier":{
"type":"string",
@ -12404,6 +12472,17 @@
},
"documentation":"<p>A list of algorithms that were used to create a model package.</p>"
},
"SourceIpConfig":{
"type":"structure",
"required":["Cidrs"],
"members":{
"Cidrs":{
"shape":"Cidrs",
"documentation":"<p>A list of one to four <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">Classless Inter-Domain Routing</a> (CIDR) values.</p> <p>Maximum: 4 CIDR values</p> <note> <p>The following Length Constraints apply to individual CIDR values in the CIDR value list.</p> </note>"
}
},
"documentation":"<p>A list of IP address ranges (<a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>). Used to create an allow list of IP addresses for a private workforce. For more information, see .</p>"
},
"SourceType":{
"type":"string",
"max":128
@ -12615,10 +12694,10 @@
"members":{
"PropertyNameQuery":{
"shape":"PropertyNameQuery",
"documentation":"<p>A type of <code>SuggestionQuery</code>. Defines a property name hint. Only property names that match the specified hint are included in the response.</p>"
"documentation":"<p>Defines a property name hint. Only property names that begin with the specified hint are included in the response.</p>"
}
},
"documentation":"<p>Limits the property names that are included in the response.</p>"
"documentation":"<p>Specified in the <a>GetSearchSuggestions</a> request. Limits the property names that are included in the response.</p>"
},
"Tag":{
"type":"structure",
@ -12694,7 +12773,7 @@
"TaskAvailabilityLifetimeInSeconds":{
"type":"integer",
"max":864000,
"min":1
"min":60
},
"TaskCount":{
"type":"integer",
@ -12801,6 +12880,12 @@
"ml.m4.4xlarge",
"ml.m4.10xlarge",
"ml.m4.16xlarge",
"ml.g4dn.xlarge",
"ml.g4dn.2xlarge",
"ml.g4dn.4xlarge",
"ml.g4dn.8xlarge",
"ml.g4dn.12xlarge",
"ml.g4dn.16xlarge",
"ml.m5.large",
"ml.m5.xlarge",
"ml.m5.2xlarge",
@ -13366,7 +13451,7 @@
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The <code>KmsKeyId</code> can be any of the following formats: </p> <ul> <li> <p>// KMS Key ID</p> <p> <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key</p> <p> <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>// KMS Key Alias</p> <p> <code>\"alias/ExampleAlias\"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key Alias</p> <p> <code>\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"</code> </p> </li> </ul> <p>If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i> </p> <p>The KMS key policy must grant permission to the IAM role that you specify in your <a>CreateModel</a> request. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\">Using Key Policies in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The <code>KmsKeyId</code> can be any of the following formats: </p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i> </p> <p>The KMS key policy must grant permission to the IAM role that you specify in your <a>CreateModel</a> request. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\">Using Key Policies in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>Describes the results of a transform job.</p>"
@ -13388,7 +13473,7 @@
},
"VolumeKmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The <code>VolumeKmsKeyId</code> can be any of the following formats:</p> <ul> <li> <p>// KMS Key ID</p> <p> <code>\"1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key</p> <p> <code>\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"</code> </p> </li> </ul>"
"documentation":"<p>The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The <code>VolumeKmsKeyId</code> can be any of the following formats:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul>"
}
},
"documentation":"<p>Describes the resources, including ML instance types and ML instance count, to use for transform job.</p>"
@ -14232,6 +14317,30 @@
}
}
},
"UpdateWorkforceRequest":{
"type":"structure",
"required":["WorkforceName"],
"members":{
"WorkforceName":{
"shape":"WorkforceName",
"documentation":"<p>The name of the private workforce whose access you want to restrict. <code>WorkforceName</code> is automatically set to <code>\"default\"</code> when a workforce is created and cannot be modified. </p>"
},
"SourceIpConfig":{
"shape":"SourceIpConfig",
"documentation":"<p>A list of one to four worker IP address ranges (<a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>) that can be used to access tasks assigned to this workforce.</p> <p>Maximum: 4 CIDR values</p>"
}
}
},
"UpdateWorkforceResponse":{
"type":"structure",
"required":["Workforce"],
"members":{
"Workforce":{
"shape":"Workforce",
"documentation":"<p>A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html\">Create a Private Workforce</a>.</p>"
}
}
},
"UpdateWorkteamRequest":{
"type":"structure",
"required":["WorkteamName"],
@ -14415,6 +14524,43 @@
"max":5,
"min":1
},
"Workforce":{
"type":"structure",
"required":[
"WorkforceName",
"WorkforceArn"
],
"members":{
"WorkforceName":{
"shape":"WorkforceName",
"documentation":"<p>The name of the private workforce whose access you want to restrict. <code>WorkforceName</code> is automatically set to <code>\"default\"</code> when a workforce is created and cannot be modified. </p>"
},
"WorkforceArn":{
"shape":"WorkforceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the private workforce.</p>"
},
"LastUpdatedDate":{
"shape":"Timestamp",
"documentation":"<p>The most recent date that was used to successfully add one or more IP address ranges (<a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>) to a private workforce's allow list.</p>"
},
"SourceIpConfig":{
"shape":"SourceIpConfig",
"documentation":"<p>A list of one to four IP address ranges (<a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">CIDRs</a>) to be added to the workforce allow list.</p>"
}
},
"documentation":"<p>A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html\">Create a Private Workforce</a>.</p>"
},
"WorkforceArn":{
"type":"string",
"max":256,
"pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workforce/.*"
},
"WorkforceName":{
"type":"string",
"max":63,
"min":1,
"pattern":"^[a-zA-Z0-9]([a-zA-Z0-9\\-])*$"
},
"Workteam":{
"type":"structure",
"required":[

View file

@ -27,7 +27,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.</p>"
"documentation":"<p>Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from.</p> <p>When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.</p>"
},
"BatchDisableStandards":{
"name":"BatchDisableStandards",
@ -43,7 +43,7 @@
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>. 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\">Standards Supported in AWS Security Hub</a>.</p>"
},
"BatchEnableStandards":{
"name":"BatchEnableStandards",
@ -59,7 +59,7 @@
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Enables the standards specified by the provided <code>standardsArn</code>. In this release, only CIS AWS Foundations standards are supported. 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>.</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>"
},
"BatchImportFindings":{
"name":"BatchImportFindings",
@ -75,7 +75,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p>"
"documentation":"<p>Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.</p> <p>The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p>"
},
"CreateActionTarget":{
"name":"CreateActionTarget",
@ -92,7 +92,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.</p>"
"documentation":"<p>Creates a custom action target in Security Hub.</p> <p>You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.</p>"
},
"CreateInsight":{
"name":"CreateInsight",
@ -109,7 +109,7 @@
{"shape":"InvalidAccessException"},
{"shape":"ResourceConflictException"}
],
"documentation":"<p>Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the <code>GroupByAttribute</code> to group the related findings in the insight.</p>"
"documentation":"<p>Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.</p> <p>To group the related findings in the insight, use the <code>GroupByAttribute</code>.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
@ -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. You can use the <a>EnableSecurityHub</a> to enable Security Hub.</p> <p>After you use <code>CreateMembers</code> to create member account associations in Security Hub, you need to use the <a>InviteMembers</a> action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, 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 being sent to both the member and master accounts.</p> <p>You can remove the association between the master and member accounts by using 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 <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>"
},
"DeclineInvitations":{
"name":"DeclineInvitations",
@ -158,7 +158,7 @@
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.</p>"
"documentation":"<p>Deletes a custom action target from Security Hub.</p> <p>Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.</p>"
},
"DeleteInsight":{
"name":"DeleteInsight",
@ -258,7 +258,23 @@
{"shape":"InvalidAccessException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.</p>"
"documentation":"<p>Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.</p>"
},
"DescribeStandardsControls":{
"name":"DescribeStandardsControls",
"http":{
"method":"GET",
"requestUri":"/standards/controls/{StandardsSubscriptionArn+}"
},
"input":{"shape":"DescribeStandardsControlsRequest"},
"output":{"shape":"DescribeStandardsControlsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"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>"
},
"DisableImportFindingsForProduct":{
"name":"DisableImportFindingsForProduct",
@ -275,7 +291,7 @@
{"shape":"InvalidAccessException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.</p>"
"documentation":"<p>Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.</p>"
},
"DisableSecurityHub":{
"name":"DisableSecurityHub",
@ -291,7 +307,7 @@
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.</p> <p>When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.</p>"
"documentation":"<p>Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub.</p> <p>When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.</p> <p>When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed.</p> <p>If you want to save your existing findings, you must export them before you disable Security Hub.</p>"
},
"DisassociateFromMasterAccount":{
"name":"DisassociateFromMasterAccount",
@ -342,7 +358,7 @@
{"shape":"ResourceConflictException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.</p>"
"documentation":"<p>Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub.</p> <p>When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.</p>"
},
"EnableSecurityHub":{
"name":"EnableSecurityHub",
@ -359,7 +375,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. 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. 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>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>"
},
"GetEnabledStandards":{
"name":"GetEnabledStandards",
@ -408,7 +424,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the results of the Security Hub insight that the insight ARN specifies.</p>"
"documentation":"<p>Lists the results of the Security Hub insight specified by the insight ARN.</p>"
},
"GetInsights":{
"name":"GetInsights",
@ -425,7 +441,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists and describes insights that insight ARNs specify.</p>"
"documentation":"<p>Lists and describes insights for the specified insight ARNs.</p>"
},
"GetInvitationsCount":{
"name":"GetInvitationsCount",
@ -458,7 +474,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Provides the details for the Security Hub master account to the current member account. </p>"
"documentation":"<p>Provides the details for the Security Hub master account for the current member account. </p>"
},
"GetMembers":{
"name":"GetMembers",
@ -475,7 +491,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns the details on the Security Hub member accounts that the account IDs specify.</p>"
"documentation":"<p>Returns the details for the Security Hub member accounts for the specified account IDs.</p>"
},
"InviteMembers":{
"name":"InviteMembers",
@ -492,7 +508,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. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the <a>CreateMembers</a> action. 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 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 <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>"
},
"ListEnabledProductsForImport":{
"name":"ListEnabledProductsForImport",
@ -507,7 +523,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.</p>"
"documentation":"<p>Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.</p>"
},
"ListInvitations":{
"name":"ListInvitations",
@ -635,7 +651,23 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the Security Hub insight that the insight ARN specifies.</p>"
"documentation":"<p>Updates the Security Hub insight identified by the specified insight ARN.</p>"
},
"UpdateStandardsControl":{
"name":"UpdateStandardsControl",
"http":{
"method":"PATCH",
"requestUri":"/standards/control/{StandardsControlArn+}"
},
"input":{"shape":"UpdateStandardsControlRequest"},
"output":{"shape":"UpdateStandardsControlResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"InvalidAccessException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Used to control whether an individual compliance standard control is enabled or disabled.</p>"
}
},
"shapes":{
@ -725,6 +757,218 @@
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"AvailabilityZone":{
"type":"structure",
"members":{
"ZoneName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the Availability Zone.</p>"
},
"SubnetId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the subnet. You can specify one subnet per Availability Zone.</p>"
}
},
"documentation":"<p>Information about an Availability Zone.</p>"
},
"AvailabilityZones":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
},
"AwsCloudFrontDistributionDetails":{
"type":"structure",
"members":{
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>The domain name corresponding to the distribution.</p>"
},
"ETag":{
"shape":"NonEmptyString",
"documentation":"<p>The entity tag is a hash of the object.</p>"
},
"LastModifiedTime":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time that the distribution was last modified.</p>"
},
"Logging":{
"shape":"AwsCloudFrontDistributionLogging",
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
},
"Origins":{
"shape":"AwsCloudFrontDistributionOrigins",
"documentation":"<p>A complex type that contains information about origins for this distribution.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the current status of the distribution.</p>"
},
"WebAclId":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p>"
}
},
"documentation":"<p>A distribution configuration.</p>"
},
"AwsCloudFrontDistributionLogging":{
"type":"structure",
"members":{
"Bucket":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon S3 bucket to store the access logs in.</p>"
},
"Enabled":{
"shape":"Boolean",
"documentation":"<p>With this field, you can enable or disable the selected distribution.</p>"
},
"IncludeCookies":{
"shape":"Boolean",
"documentation":"<p>Specifies whether you want CloudFront to include cookies in access logs.</p>"
},
"Prefix":{
"shape":"NonEmptyString",
"documentation":"<p>An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.</p>"
}
},
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
},
"AwsCloudFrontDistributionOriginItem":{
"type":"structure",
"members":{
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin.</p>"
},
"Id":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier for the origin or origin group.</p>"
},
"OriginPath":{
"shape":"NonEmptyString",
"documentation":"<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.</p>"
}
},
"documentation":"<p>A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon MediaStore, or other server from which CloudFront gets your files.</p>"
},
"AwsCloudFrontDistributionOriginItemList":{
"type":"list",
"member":{"shape":"AwsCloudFrontDistributionOriginItem"}
},
"AwsCloudFrontDistributionOrigins":{
"type":"structure",
"members":{
"Items":{
"shape":"AwsCloudFrontDistributionOriginItemList",
"documentation":"<p>A complex type that contains origins or origin groups for this distribution.</p>"
}
},
"documentation":"<p>A complex type that contains information about origins and origin groups for this distribution.</p>"
},
"AwsCodeBuildProjectDetails":{
"type":"structure",
"members":{
"EncryptionKey":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the build output artifacts.</p> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK alias (using the format alias/alias-name). </p>"
},
"Environment":{
"shape":"AwsCodeBuildProjectEnvironment",
"documentation":"<p>Information about the build environment for this build project.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the build project.</p>"
},
"Source":{
"shape":"AwsCodeBuildProjectSource",
"documentation":"<p>Information about the build input source code for this build project.</p>"
},
"ServiceRole":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>"
},
"VpcConfig":{
"shape":"AwsCodeBuildProjectVpcConfig",
"documentation":"<p>Information about the VPC configuration that AWS CodeBuild accesses.</p>"
}
},
"documentation":"<p>Information about an AWS CodeBuild project.</p>"
},
"AwsCodeBuildProjectEnvironment":{
"type":"structure",
"members":{
"Certificate":{
"shape":"NonEmptyString",
"documentation":"<p>The certificate to use with this build project.</p>"
},
"ImagePullCredentialsType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of credentials AWS CodeBuild uses to pull images in your build.</p> <p>Valid values:</p> <ul> <li> <p> <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the AWS CodeBuild service principal.</p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role.</p> </li> </ul> <p>When you use a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When you use an AWS CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>"
},
"RegistryCredential":{
"shape":"AwsCodeBuildProjectEnvironmentRegistryCredential",
"documentation":"<p>The credentials for access to a private registry.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of build environment to use for related builds.</p> <p>The environment type <code>ARM_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).</p> <p>The environment type <code>LINUX_CONTAINER</code> with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> <p>Valid values: <code>WINDOWS_CONTAINER</code> | <code>LINUX_CONTAINER</code> | <code>LINUX_GPU_CONTAINER</code> | <code>ARM_CONTAINER</code> </p>"
}
},
"documentation":"<p>Information about the build environment for this build project.</p>"
},
"AwsCodeBuildProjectEnvironmentRegistryCredential":{
"type":"structure",
"members":{
"Credential":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.</p> <note> <p>The credential can use the name of the credentials only if they exist in your current AWS Region. </p> </note>"
},
"CredentialProvider":{
"shape":"NonEmptyString",
"documentation":"<p>The service that created the credentials to access a private Docker registry.</p> <p>The valid value,<code> SECRETS_MANAGER</code>, is for AWS Secrets Manager.</p>"
}
},
"documentation":"<p>The credentials for access to a private registry.</p>"
},
"AwsCodeBuildProjectSource":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of repository that contains the source code to be built. Valid values are:</p> <ul> <li> <p> <code>BITBUCKET</code> - The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code> - The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code> - The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code> - The source code is in a GitHub repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code> - The source code is in a GitHub Enterprise repository.</p> </li> <li> <p> <code>NO_SOURCE</code> - The project does not have input source code.</p> </li> <li> <p> <code>S3</code> - The source code is in an S3 input bucket. </p> </li> </ul>"
},
"Location":{
"shape":"NonEmptyString",
"documentation":"<p>Information about the location of the source code to be built.</p> <p>Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name</code> ).</p> </li> <li> <p>For source code in an S3 input bucket, one of the following.</p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code>bucket-name/path/to/object-name.zip</code>).</p> </li> <li> <p> The path to the folder that contains the source code (for example, <code>bucket-name/path/to/source-code/folder/</code>).</p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. </p> </li> </ul>"
},
"GitCloneDepth":{
"shape":"Integer",
"documentation":"<p>Information about the Git clone depth for the build project.</p>"
},
"InsecureSsl":{
"shape":"Boolean",
"documentation":"<p>Whether to ignore SSL warnings while connecting to the project source code.</p>"
}
},
"documentation":"<p>Information about the build input source code for this build project.</p>"
},
"AwsCodeBuildProjectVpcConfig":{
"type":"structure",
"members":{
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC.</p>"
},
"Subnets":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of one or more subnet IDs in your Amazon VPC.</p>"
},
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of one or more security group IDs in your Amazon VPC.</p>"
}
},
"documentation":"<p>Information about the VPC configuration that AWS CodeBuild accesses.</p>"
},
"AwsEc2InstanceDetails":{
"type":"structure",
"members":{
@ -767,12 +1011,384 @@
},
"documentation":"<p>The details of an Amazon EC2 instance.</p>"
},
"AwsEc2NetworkInterfaceAttachment":{
"type":"structure",
"members":{
"AttachTime":{
"shape":"NonEmptyString",
"documentation":"<p>The timestamp indicating when the attachment initiated.</p>"
},
"AttachmentId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the network interface attachment</p>"
},
"DeleteOnTermination":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the network interface is deleted when the instance is terminated.</p>"
},
"DeviceIndex":{
"shape":"Integer",
"documentation":"<p>The device index of the network interface attachment on the instance.</p>"
},
"InstanceId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the instance.</p>"
},
"InstanceOwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the owner of the instance.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The attachment state.</p> <p>Valid values: <code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code> </p>"
}
},
"documentation":"<p>Information about the network interface attachment.</p>"
},
"AwsEc2NetworkInterfaceDetails":{
"type":"structure",
"members":{
"Attachment":{
"shape":"AwsEc2NetworkInterfaceAttachment",
"documentation":"<p>The network interface attachment.</p>"
},
"NetworkInterfaceId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the network interface.</p>"
},
"SecurityGroups":{
"shape":"AwsEc2NetworkInterfaceSecurityGroupList",
"documentation":"<p>Security groups for the network interface.</p>"
},
"SourceDestCheck":{
"shape":"Boolean",
"documentation":"<p>Indicates whether traffic to or from the instance is validated.</p>"
}
},
"documentation":"<p>Details about the network interface</p>"
},
"AwsEc2NetworkInterfaceSecurityGroup":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
}
},
"documentation":"<p>A security group associated with the network interface.</p>"
},
"AwsEc2NetworkInterfaceSecurityGroupList":{
"type":"list",
"member":{"shape":"AwsEc2NetworkInterfaceSecurityGroup"}
},
"AwsEc2SecurityGroupDetails":{
"type":"structure",
"members":{
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
},
"OwnerId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS account ID of the owner of the security group.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>[VPC only] The ID of the VPC for the security group.</p>"
},
"IpPermissions":{
"shape":"AwsEc2SecurityGroupIpPermissionList",
"documentation":"<p>The inbound rules associated with the security group.</p>"
},
"IpPermissionsEgress":{
"shape":"AwsEc2SecurityGroupIpPermissionList",
"documentation":"<p>[VPC only] The outbound rules associated with the security group.</p>"
}
},
"documentation":"<p>Details about an EC2 security group.</p>"
},
"AwsEc2SecurityGroupIpPermission":{
"type":"structure",
"members":{
"IpProtocol":{
"shape":"NonEmptyString",
"documentation":"<p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number.</p> <p>[VPC only] Use <code>-1</code> to specify all protocols.</p> <p>When authorizing security group rules, specifying -1 or a protocol number other than <code>tcp</code>, <code>udp</code>, <code>icmp</code>, or <code>icmpv6</code> allows traffic on all ports, regardless of any port range you specify.</p> <p>For <code>tcp</code>, <code>udp</code>, and <code>icmp</code>, you must specify a port range.</p> <p>For <code>icmpv6</code>, the port range is optional. If you omit the port range, traffic for all types and codes is allowed. </p>"
},
"FromPort":{
"shape":"Integer",
"documentation":"<p>The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.</p> <p>A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. </p>"
},
"ToPort":{
"shape":"Integer",
"documentation":"<p>The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.</p> <p>A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.</p>"
},
"UserIdGroupPairs":{
"shape":"AwsEc2SecurityGroupUserIdGroupPairList",
"documentation":"<p>The security group and AWS account ID pairs.</p>"
},
"IpRanges":{
"shape":"AwsEc2SecurityGroupIpRangeList",
"documentation":"<p>The IPv4 ranges.</p>"
},
"Ipv6Ranges":{
"shape":"AwsEc2SecurityGroupIpv6RangeList",
"documentation":"<p>The IPv6 ranges.</p>"
},
"PrefixListIds":{
"shape":"AwsEc2SecurityGroupPrefixListIdList",
"documentation":"<p>[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.</p>"
}
},
"documentation":"<p>An IP permission for an EC2 security group.</p>"
},
"AwsEc2SecurityGroupIpPermissionList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpPermission"}
},
"AwsEc2SecurityGroupIpRange":{
"type":"structure",
"members":{
"CidrIp":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv4 CIDR range. You can either specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.</p>"
}
},
"documentation":"<p>A range of IPv4 addresses.</p>"
},
"AwsEc2SecurityGroupIpRangeList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpRange"}
},
"AwsEc2SecurityGroupIpv6Range":{
"type":"structure",
"members":{
"CidrIpv6":{
"shape":"NonEmptyString",
"documentation":"<p>The IPv6 CIDR range. You can either specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.</p>"
}
},
"documentation":"<p>A range of IPv6 addresses.</p>"
},
"AwsEc2SecurityGroupIpv6RangeList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupIpv6Range"}
},
"AwsEc2SecurityGroupPrefixListId":{
"type":"structure",
"members":{
"PrefixListId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the prefix.</p>"
}
},
"documentation":"<p>A prefix list ID.</p>"
},
"AwsEc2SecurityGroupPrefixListIdList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupPrefixListId"}
},
"AwsEc2SecurityGroupUserIdGroupPair":{
"type":"structure",
"members":{
"GroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the security group.</p>"
},
"GroupName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the security group.</p>"
},
"PeeringStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The status of a VPC peering connection, if applicable.</p>"
},
"UserId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS account.</p> <p>For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.</p> <p>[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS. </p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC for the referenced security group, if applicable.</p>"
},
"VpcPeeringConnectionId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC peering connection, if applicable.</p>"
}
},
"documentation":"<p>A relationship between a security group and a user.</p>"
},
"AwsEc2SecurityGroupUserIdGroupPairList":{
"type":"list",
"member":{"shape":"AwsEc2SecurityGroupUserIdGroupPair"}
},
"AwsElasticsearchDomainDetails":{
"type":"structure",
"members":{
"AccessPolicies":{
"shape":"NonEmptyString",
"documentation":"<p>IAM policy document specifying the access policies for the new Amazon ES domain.</p>"
},
"DomainEndpointOptions":{
"shape":"AwsElasticsearchDomainDomainEndpointOptions",
"documentation":"<p>Additional options for the domain endpoint.</p>"
},
"DomainId":{
"shape":"NonEmptyString",
"documentation":"<p>Unique identifier for an Amazon ES domain.</p>"
},
"DomainName":{
"shape":"NonEmptyString",
"documentation":"<p>Name of an Amazon ES domain.</p> <p>Domain names are unique across all domains owned by the same account within an AWS Region.</p> <p>Domain names must start with a lowercase letter and must be between 3 and 28 characters.</p> <p>Valid characters are a-z (lowercase only), 0-9, and (hyphen). </p>"
},
"Endpoint":{
"shape":"NonEmptyString",
"documentation":"<p>Domain-specific endpoint used to submit index, search, and data upload requests to an Amazon ES domain.</p> <p>The endpoint is a service URL. </p>"
},
"Endpoints":{
"shape":"FieldMap",
"documentation":"<p>The key-value pair that exists if the Amazon ES domain uses VPC endpoints.</p>"
},
"ElasticsearchVersion":{
"shape":"NonEmptyString",
"documentation":"<p>Elasticsearch version.</p>"
},
"EncryptionAtRestOptions":{
"shape":"AwsElasticsearchDomainEncryptionAtRestOptions",
"documentation":"<p>Details about the configuration for encryption at rest.</p>"
},
"NodeToNodeEncryptionOptions":{
"shape":"AwsElasticsearchDomainNodeToNodeEncryptionOptions",
"documentation":"<p>Details about the configuration for node-to-node encryption.</p>"
},
"VPCOptions":{
"shape":"AwsElasticsearchDomainVPCOptions",
"documentation":"<p>Information that Amazon ES derives based on <code>VPCOptions</code> for the domain.</p>"
}
},
"documentation":"<p>Information about an Elasticsearch domain.</p>"
},
"AwsElasticsearchDomainDomainEndpointOptions":{
"type":"structure",
"members":{
"EnforceHTTPS":{
"shape":"Boolean",
"documentation":"<p>Whether to require that all traffic to the domain arrive over HTTPS.</p>"
},
"TLSSecurityPolicy":{
"shape":"NonEmptyString",
"documentation":"<p>The TLS security policy to apply to the HTTPS endpoint of the Elasticsearch domain.</p> <p>Valid values:</p> <ul> <li> <p> <code>Policy-Min-TLS-1-0-2019-07</code>, which supports TLSv1.0 and higher</p> </li> <li> <p> <code>Policy-Min-TLS-1-2-2019-07</code>, which only supports TLSv1.2</p> </li> </ul>"
}
},
"documentation":"<p>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.</p>"
},
"AwsElasticsearchDomainEncryptionAtRestOptions":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Whether encryption at rest is enabled.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.</p>"
}
},
"documentation":"<p>Details about the configuration for encryption at rest.</p>"
},
"AwsElasticsearchDomainNodeToNodeEncryptionOptions":{
"type":"structure",
"members":{
"Enabled":{
"shape":"Boolean",
"documentation":"<p>Whether node-to-node encryption is enabled.</p>"
}
},
"documentation":"<p>Details about the configuration for node-to-node encryption.</p>"
},
"AwsElasticsearchDomainVPCOptions":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"NonEmptyStringList",
"documentation":"<p>The list of Availability Zones associated with the VPC subnets.</p>"
},
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>The list of security group IDs associated with the VPC endpoints for the domain.</p>"
},
"SubnetIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of subnet IDs associated with the VPC endpoints for the domain.</p>"
},
"VPCId":{
"shape":"NonEmptyString",
"documentation":"<p>ID for the VPC.</p>"
}
},
"documentation":"<p>Information that Amazon ES derives based on <code>VPCOptions</code> for the domain.</p>"
},
"AwsElbv2LoadBalancerDetails":{
"type":"structure",
"members":{
"AvailabilityZones":{
"shape":"AvailabilityZones",
"documentation":"<p>The Availability Zones for the load balancer.</p>"
},
"CanonicalHostedZoneId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the Amazon Route 53 hosted zone associated with the load balancer.</p>"
},
"CreatedTime":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time the load balancer was created.</p>"
},
"DNSName":{
"shape":"NonEmptyString",
"documentation":"<p>The public DNS name of the load balancer.</p>"
},
"IpAddressType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses).</p>"
},
"Scheme":{
"shape":"NonEmptyString",
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses.</p>"
},
"SecurityGroups":{
"shape":"SecurityGroups",
"documentation":"<p>The IDs of the security groups for the load balancer.</p>"
},
"State":{
"shape":"LoadBalancerState",
"documentation":"<p>The state of the load balancer.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of load balancer.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC for the load balancer.</p>"
}
},
"documentation":"<p>Information about a load balancer.</p>"
},
"AwsIamAccessKeyDetails":{
"type":"structure",
"members":{
"UserName":{
"shape":"NonEmptyString",
"documentation":"<p>The user associated with the IAM access key related to a finding.</p>"
"documentation":"<p>The user associated with the IAM access key related to a finding.</p> <p>The <code>UserName</code> parameter has been replaced with the <code>PrincipalName</code> parameter because access keys can also be assigned to principals that are not IAM users.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use PrincipalName instead."
},
"Status":{
"shape":"AwsIamAccessKeyStatus",
@ -781,6 +1397,18 @@
"CreatedAt":{
"shape":"NonEmptyString",
"documentation":"<p>The creation date/time of the IAM access key related to a finding.</p>"
},
"PrincipalId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the principal associated with an access key.</p>"
},
"PrincipalType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of principal associated with an access key.</p>"
},
"PrincipalName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the principal.</p>"
}
},
"documentation":"<p>IAM access key details related to a finding.</p>"
@ -792,6 +1420,415 @@
"Inactive"
]
},
"AwsIamRoleAssumeRolePolicyDocument":{
"type":"string",
"max":131072,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+"
},
"AwsIamRoleDetails":{
"type":"structure",
"members":{
"AssumeRolePolicyDocument":{
"shape":"AwsIamRoleAssumeRolePolicyDocument",
"documentation":"<p>The trust policy that grants permission to assume the role.</p>"
},
"CreateDate":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time, in ISO 8601 date-time format, when the role was created.</p>"
},
"RoleId":{
"shape":"NonEmptyString",
"documentation":"<p>The stable and unique string identifying the role.</p>"
},
"RoleName":{
"shape":"NonEmptyString",
"documentation":"<p>The friendly name that identifies the role.</p>"
},
"MaxSessionDuration":{
"shape":"Integer",
"documentation":"<p>The maximum session duration (in seconds) that you want to set for the specified role.</p>"
},
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the role.</p>"
}
},
"documentation":"<p>Contains information about an IAM role, including all of the role's policies.</p>"
},
"AwsKmsKeyDetails":{
"type":"structure",
"members":{
"AWSAccountId":{
"shape":"NonEmptyString",
"documentation":"<p>The twelve-digit account ID of the AWS account that owns the CMK.</p>"
},
"CreationDate":{
"shape":"Double",
"documentation":"<p>The date and time when the CMK was created.</p>"
},
"KeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The globally unique identifier for the CMK.</p>"
},
"KeyManager":{
"shape":"NonEmptyString",
"documentation":"<p>The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.</p>"
},
"KeyState":{
"shape":"NonEmptyString",
"documentation":"<p>The state of the CMK.</p>"
},
"Origin":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the CMK's key material.</p> <p>When this value is <code>AWS_KMS</code>, AWS KMS created the key material.</p> <p>When this value is <code>EXTERNAL</code>, the key material was imported from your existing key management infrastructure or the CMK lacks key material.</p> <p>When this value is <code>AWS_CLOUDHSM</code>, the key material was created in the AWS CloudHSM cluster associated with a custom key store.</p>"
}
},
"documentation":"<p>Contains metadata about a customer master key (CMK).</p>"
},
"AwsLambdaFunctionCode":{
"type":"structure",
"members":{
"S3Bucket":{
"shape":"NonEmptyString",
"documentation":"<p>An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.</p>"
},
"S3Key":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon S3 key of the deployment package.</p>"
},
"S3ObjectVersion":{
"shape":"NonEmptyString",
"documentation":"<p>For versioned objects, the version of the deployment package object to use.</p>"
},
"ZipFile":{
"shape":"NonEmptyString",
"documentation":"<p>The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.</p>"
}
},
"documentation":"<p>The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.</p>"
},
"AwsLambdaFunctionDeadLetterConfig":{
"type":"structure",
"members":{
"TargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.</p>"
}
},
"documentation":"<p>The dead-letter queue for failed asynchronous invocations.</p>"
},
"AwsLambdaFunctionDetails":{
"type":"structure",
"members":{
"Code":{
"shape":"AwsLambdaFunctionCode",
"documentation":"<p>An <code>AwsLambdaFunctionCode</code> object.</p>"
},
"CodeSha256":{
"shape":"NonEmptyString",
"documentation":"<p>The SHA256 hash of the function's deployment package.</p>"
},
"DeadLetterConfig":{
"shape":"AwsLambdaFunctionDeadLetterConfig",
"documentation":"<p>The function's dead letter queue.</p>"
},
"Environment":{
"shape":"AwsLambdaFunctionEnvironment",
"documentation":"<p>The function's environment variables.</p>"
},
"FunctionName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the function.</p>"
},
"Handler":{
"shape":"NonEmptyString",
"documentation":"<p>The function that Lambda calls to begin executing your function.</p>"
},
"KmsKeyArn":{
"shape":"NonEmptyString",
"documentation":"<p>The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.</p>"
},
"LastModified":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).</p>"
},
"Layers":{
"shape":"AwsLambdaFunctionLayerList",
"documentation":"<p>The function's layers.</p>"
},
"MasterArn":{
"shape":"NonEmptyString",
"documentation":"<p>For Lambda@Edge functions, the ARN of the master function.</p>"
},
"MemorySize":{
"shape":"Integer",
"documentation":"<p>The memory that's allocated to the function.</p>"
},
"RevisionId":{
"shape":"NonEmptyString",
"documentation":"<p>The latest updated revision of the function or alias.</p>"
},
"Role":{
"shape":"NonEmptyString",
"documentation":"<p>The function's execution role.</p>"
},
"Runtime":{
"shape":"NonEmptyString",
"documentation":"<p>The runtime environment for the Lambda function.</p>"
},
"Timeout":{
"shape":"Integer",
"documentation":"<p>The amount of time that Lambda allows a function to run before stopping it.</p>"
},
"TracingConfig":{
"shape":"AwsLambdaFunctionTracingConfig",
"documentation":"<p>The function's AWS X-Ray tracing configuration.</p>"
},
"VpcConfig":{
"shape":"AwsLambdaFunctionVpcConfig",
"documentation":"<p>The function's networking configuration.</p>"
},
"Version":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the Lambda function.</p>"
}
},
"documentation":"<p>Details about a function's configuration.</p>"
},
"AwsLambdaFunctionEnvironment":{
"type":"structure",
"members":{
"Variables":{
"shape":"FieldMap",
"documentation":"<p>Environment variable key-value pairs.</p>"
},
"Error":{
"shape":"AwsLambdaFunctionEnvironmentError",
"documentation":"<p>An <code>AwsLambdaFunctionEnvironmentError</code> object.</p>"
}
},
"documentation":"<p>A function's environment variable settings.</p>"
},
"AwsLambdaFunctionEnvironmentError":{
"type":"structure",
"members":{
"ErrorCode":{
"shape":"NonEmptyString",
"documentation":"<p>The error code.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>Error messages for environment variables that couldn't be applied.</p>"
},
"AwsLambdaFunctionLayer":{
"type":"structure",
"members":{
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the function layer.</p>"
},
"CodeSize":{
"shape":"Integer",
"documentation":"<p>The size of the layer archive in bytes.</p>"
}
},
"documentation":"<p>An AWS Lambda layer.</p>"
},
"AwsLambdaFunctionLayerList":{
"type":"list",
"member":{"shape":"AwsLambdaFunctionLayer"}
},
"AwsLambdaFunctionTracingConfig":{
"type":"structure",
"members":{
"Mode":{
"shape":"NonEmptyString",
"documentation":"<p>The tracing mode.</p>"
}
},
"documentation":"<p>The function's AWS X-Ray tracing configuration.</p>"
},
"AwsLambdaFunctionVpcConfig":{
"type":"structure",
"members":{
"SecurityGroupIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of VPC security groups IDs.</p>"
},
"SubnetIds":{
"shape":"NonEmptyStringList",
"documentation":"<p>A list of VPC subnet IDs.</p>"
},
"VpcId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the VPC.</p>"
}
},
"documentation":"<p>The VPC security groups and subnets that are attached to a Lambda function. For more information, see VPC Settings.</p>"
},
"AwsLambdaLayerVersionDetails":{
"type":"structure",
"members":{
"Version":{
"shape":"AwsLambdaLayerVersionNumber",
"documentation":"<p>The version number.</p>"
},
"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>"
},
"CreatedDate":{
"shape":"NonEmptyString",
"documentation":"<p>The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000. </p>"
}
},
"documentation":"<p>Details about a Lambda layer version.</p>"
},
"AwsLambdaLayerVersionNumber":{"type":"long"},
"AwsRdsDbInstanceAssociatedRole":{
"type":"structure",
"members":{
"RoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.</p>"
},
"FeatureName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the feature associated with the IAM)role.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>Describes the state of the association between the IAM role and the DB instance. The <code>Status</code> property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - the IAM role ARN is being associated with the DB instance.</p> </li> <li> <p> <code>INVALID</code> - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf. </p> </li> </ul>"
}
},
"documentation":"<p>An AWS Identity and Access Management (IAM) role associated with the DB instance.</p>"
},
"AwsRdsDbInstanceAssociatedRoles":{
"type":"list",
"member":{"shape":"AwsRdsDbInstanceAssociatedRole"}
},
"AwsRdsDbInstanceDetails":{
"type":"structure",
"members":{
"AssociatedRoles":{
"shape":"AwsRdsDbInstanceAssociatedRoles",
"documentation":"<p>The AWS Identity and Access Management (IAM) roles associated with the DB instance.</p>"
},
"CACertificateIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the CA certificate for this DB instance.</p>"
},
"DBClusterIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.</p>"
},
"DBInstanceIdentifier":{
"shape":"NonEmptyString",
"documentation":"<p>Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.</p>"
},
"DBInstanceClass":{
"shape":"NonEmptyString",
"documentation":"<p>Contains the name of the compute and memory capacity class of the DB instance.</p>"
},
"DbInstancePort":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.</p>"
},
"DbiResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. </p>"
},
"DBName":{
"shape":"NonEmptyString",
"documentation":"<p>The meaning of this parameter differs according to the database engine you use.</p> <p> <b>MySQL, MariaDB, SQL Server, PostgreSQL</b> </p> <p>Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.</p> <p> <b>Oracle</b> </p> <p>Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance. </p>"
},
"DeletionProtection":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the DB instance has deletion protection enabled.</p> <p>When deletion protection is enabled, the database cannot be deleted.</p>"
},
"Endpoint":{
"shape":"AwsRdsDbInstanceEndpoint",
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"Engine":{
"shape":"NonEmptyString",
"documentation":"<p>Provides the name of the database engine to use for this DB instance.</p>"
},
"EngineVersion":{
"shape":"NonEmptyString",
"documentation":"<p>Indicates the database engine version.</p>"
},
"IAMDatabaseAuthenticationEnabled":{
"shape":"Boolean",
"documentation":"<p>True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p> <p>IAM database authentication can be enabled for the following database engines.</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> <li> <p>Aurora 5.6 or higher</p> </li> </ul>"
},
"InstanceCreateTime":{
"shape":"NonEmptyString",
"documentation":"<p>Provides the date and time the DB instance was created.</p>"
},
"KmsKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>If <code>StorageEncrypted</code> is true, the AWS KMS key identifier for the encrypted DB instance.</p>"
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Specifies the accessibility options for the DB instance.</p> <p>A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.</p> <p>A value of false specifies an internal instance with a DNS name that resolves to a private IP address. </p>"
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p>"
},
"TdeCredentialArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN from the key store with which the instance is associated for TDE encryption.</p>"
},
"VpcSecurityGroups":{
"shape":"AwsRdsDbInstanceVpcSecurityGroups",
"documentation":"<p>A list of VPC security groups that the DB instance belongs to.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon RDS DB instance.</p>"
},
"AwsRdsDbInstanceEndpoint":{
"type":"structure",
"members":{
"Address":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the DNS address of the DB instance.</p>"
},
"Port":{
"shape":"Integer",
"documentation":"<p>Specifies the port that the database engine is listening on.</p>"
},
"HostedZoneId":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</p>"
}
},
"documentation":"<p>Specifies the connection endpoint.</p>"
},
"AwsRdsDbInstanceVpcSecurityGroup":{
"type":"structure",
"members":{
"VpcSecurityGroupId":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the VPC security group.</p>"
},
"Status":{
"shape":"NonEmptyString",
"documentation":"<p>The status of the VPC security group.</p>"
}
},
"documentation":"<p>A VPC security groups that the DB instance belongs to.</p>"
},
"AwsRdsDbInstanceVpcSecurityGroups":{
"type":"list",
"member":{"shape":"AwsRdsDbInstanceVpcSecurityGroup"}
},
"AwsS3BucketDetails":{
"type":"structure",
"members":{
@ -869,11 +1906,11 @@
},
"Confidence":{
"shape":"Integer",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"Integer",
"documentation":"<p>The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"Title":{
"shape":"NonEmptyString",
@ -913,7 +1950,7 @@
},
"ThreatIntelIndicators":{
"shape":"ThreatIntelIndicatorList",
"documentation":"<p>Threat intel details related to a finding.</p>"
"documentation":"<p>Threat intelligence details related to a finding.</p>"
},
"Resources":{
"shape":"ResourceList",
@ -999,11 +2036,11 @@
},
"Confidence":{
"shape":"NumberFilterList",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"NumberFilterList",
"documentation":"<p>The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"Title":{
"shape":"StringFilterList",
@ -1123,27 +2160,27 @@
},
"ThreatIntelIndicatorType":{
"shape":"StringFilterList",
"documentation":"<p>The type of a threat intel indicator.</p>"
"documentation":"<p>The type of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorValue":{
"shape":"StringFilterList",
"documentation":"<p>The value of a threat intel indicator.</p>"
"documentation":"<p>The value of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorCategory":{
"shape":"StringFilterList",
"documentation":"<p>The category of a threat intel indicator.</p>"
"documentation":"<p>The category of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorLastObservedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time of the last observation of a threat intel indicator.</p>"
"documentation":"<p>The date/time of the last observation of a threat intelligence indicator.</p>"
},
"ThreatIntelIndicatorSource":{
"shape":"StringFilterList",
"documentation":"<p>The source of the threat intel.</p>"
"documentation":"<p>The source of the threat intelligence.</p>"
},
"ThreatIntelIndicatorSourceUrl":{
"shape":"StringFilterList",
"documentation":"<p>The URL for more details from the source of the threat intel.</p>"
"documentation":"<p>The URL for more details from the source of the threat intelligence.</p>"
},
"ResourceType":{
"shape":"StringFilterList",
@ -1199,7 +2236,7 @@
},
"ResourceAwsEc2InstanceLaunchedAt":{
"shape":"DateFilterList",
"documentation":"<p>The date/time the instance was launched.</p>"
"documentation":"<p>The date and time the instance was launched.</p>"
},
"ResourceAwsS3BucketOwnerId":{
"shape":"StringFilterList",
@ -1282,12 +2319,130 @@
"documentation":"<p>A keyword for a finding.</p>"
}
},
"documentation":"<p>A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight. </p>"
"documentation":"<p>A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.</p>"
},
"AwsSecurityFindingList":{
"type":"list",
"member":{"shape":"AwsSecurityFinding"}
},
"AwsSnsTopicDetails":{
"type":"structure",
"members":{
"KmsMasterKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK.</p>"
},
"Subscription":{
"shape":"AwsSnsTopicSubscriptionList",
"documentation":"<p>Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.</p>"
},
"TopicName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the topic.</p>"
},
"Owner":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's owner.</p>"
}
},
"documentation":"<p>A wrapper type for the topic's Amazon Resource Name (ARN).</p>"
},
"AwsSnsTopicSubscription":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's endpoint (format depends on the protocol).</p>"
},
"Protocol":{
"shape":"NonEmptyString",
"documentation":"<p>The subscription's protocol.</p>"
}
},
"documentation":"<p>A wrapper type for the attributes of an Amazon SNS subscription.</p>"
},
"AwsSnsTopicSubscriptionList":{
"type":"list",
"member":{"shape":"AwsSnsTopicSubscription"}
},
"AwsSqsQueueDetails":{
"type":"structure",
"members":{
"KmsDataKeyReusePeriodSeconds":{
"shape":"Integer",
"documentation":"<p>The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.</p>"
},
"KmsMasterKeyId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK.</p>"
},
"QueueName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the new queue.</p>"
},
"DeadLetterTargetArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. </p>"
}
},
"documentation":"<p>Data about a queue.</p>"
},
"AwsWafWebAclDetails":{
"type":"structure",
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.</p>"
},
"DefaultAction":{
"shape":"NonEmptyString",
"documentation":"<p>The action to perform if none of the Rules contained in the WebACL match.</p>"
},
"Rules":{
"shape":"AwsWafWebAclRuleList",
"documentation":"<p>An array that contains the action for each rule in a WebACL, the priority of the rule, and the ID of the rule.</p>"
},
"WebAclId":{
"shape":"NonEmptyString",
"documentation":"<p>A unique identifier for a WebACL.</p>"
}
},
"documentation":"<p>Details about a WAF WebACL.</p>"
},
"AwsWafWebAclRule":{
"type":"structure",
"members":{
"Action":{
"shape":"WafAction",
"documentation":"<p>Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. </p>"
},
"ExcludedRules":{
"shape":"WafExcludedRuleList",
"documentation":"<p>Rules to exclude from a rule group.</p>"
},
"OverrideAction":{
"shape":"WafOverrideAction",
"documentation":"<p>Use the <code>OverrideAction</code> to test your RuleGroup.</p> <p>Any rule in a RuleGroup can potentially block a request. If you set the <code>OverrideAction</code> to <code>None</code>, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.</p> <p>However, if you first want to test the RuleGroup, set the <code>OverrideAction</code> to <code>Count</code>. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.</p> <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use <code>ActivatedRule</code>|<code>Action</code>. For all other update requests, <code>ActivatedRule</code>|<code>Action</code> is used instead of <code>ActivatedRule</code>|<code>OverrideAction</code>. </p>"
},
"Priority":{
"shape":"Integer",
"documentation":"<p>Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values do not need to be consecutive.</p>"
},
"RuleId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier for a Rule.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The rule type.</p> <p>Valid values: <code>REGULAR</code> | <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is <code>REGULAR</code>.</p>"
}
},
"documentation":"<p>Details for a rule in a WAF WebACL.</p>"
},
"AwsWafWebAclRuleList":{
"type":"list",
"member":{"shape":"AwsWafWebAclRule"}
},
"BatchDisableStandardsRequest":{
"type":"structure",
"required":["StandardsSubscriptionArns"],
@ -1332,7 +2487,7 @@
"members":{
"Findings":{
"shape":"AwsSecurityFindingList",
"documentation":"<p>A list of findings to import. To successfully import a finding, it must follow the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">AWS Security Finding Format</a>.</p>"
"documentation":"<p>A list of findings to import. To successfully import a finding, it must follow the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">AWS Security Finding Format</a>. Maximum of 100 findings per request.</p>"
}
}
},
@ -1353,7 +2508,7 @@
},
"FailedFindings":{
"shape":"ImportFindingsErrorList",
"documentation":"<p>The list of the findings that failed to import.</p>"
"documentation":"<p>The list of findings that failed to import.</p>"
}
}
},
@ -1368,9 +2523,13 @@
"Status":{
"shape":"ComplianceStatus",
"documentation":"<p>The result of a compliance 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>"
"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>"
},
"ComplianceStatus":{
"type":"string",
@ -1403,6 +2562,13 @@
},
"documentation":"<p>Container details related to a finding.</p>"
},
"ControlStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"CreateActionTargetRequest":{
"type":"structure",
"required":[
@ -1449,7 +2615,7 @@
},
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.</p>"
"documentation":"<p>One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
@ -1472,7 +2638,7 @@
"members":{
"AccountDetails":{
"shape":"AccountDetailsList",
"documentation":"<p>A list of account ID and email address pairs of the accounts to associate with the Security Hub master account.</p>"
"documentation":"<p>The list of accounts to associate with the Security Hub master account. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1481,7 +2647,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that weren't processed.</p>"
"documentation":"<p>The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1531,7 +2697,7 @@
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>A list of account IDs that specify the accounts that invitations to Security Hub are declined from.</p>"
"documentation":"<p>The list of account IDs for the accounts from which to decline the invitations to Security Hub.</p>"
}
}
},
@ -1540,7 +2706,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that weren't processed.</p>"
"documentation":"<p>The list of AWS accounts that were not processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1594,7 +2760,7 @@
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>A list of the account IDs that sent the invitations to delete.</p>"
"documentation":"<p>The list of the account IDs that sent the invitations to delete.</p>"
}
}
},
@ -1603,7 +2769,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that invitations weren't deleted for.</p>"
"documentation":"<p>The list of AWS accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1612,7 +2778,7 @@
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>A list of account IDs of the member accounts to delete.</p>"
"documentation":"<p>The list of account IDs for the member accounts to delete.</p>"
}
}
},
@ -1621,7 +2787,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that weren't deleted.</p>"
"documentation":"<p>The list of AWS accounts that were not deleted. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1672,7 +2838,7 @@
"members":{
"HubArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the Hub resource retrieved.</p>"
"documentation":"<p>The ARN of the Hub resource that was retrieved.</p>"
},
"SubscribedAt":{
"shape":"NonEmptyString",
@ -1711,6 +2877,43 @@
}
}
},
"DescribeStandardsControlsRequest":{
"type":"structure",
"required":["StandardsSubscriptionArn"],
"members":{
"StandardsSubscriptionArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of a resource that represents your subscription to a supported standard.</p>",
"location":"uri",
"locationName":"StandardsSubscriptionArn"
},
"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>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of compliance standard controls to return.</p>",
"location":"querystring",
"locationName":"MaxResults"
}
}
},
"DescribeStandardsControlsResponse":{
"type":"structure",
"members":{
"Controls":{
"shape":"StandardsControls",
"documentation":"<p>A list of compliance 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>"
}
}
},
"DisableImportFindingsForProductRequest":{
"type":"structure",
"required":["ProductSubscriptionArn"],
@ -1806,11 +3009,11 @@
"members":{
"StandardsSubscriptionArns":{
"shape":"StandardsSubscriptionArns",
"documentation":"<p>A list of the standards subscription ARNs for the standards to retrieve.</p>"
"documentation":"<p>The list of the standards subscription ARNs for the standards to retrieve.</p>"
},
"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>. For subsequent calls to the operation, fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data.</p>"
"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>"
},
"MaxResults":{
"shape":"MaxResults",
@ -1823,7 +3026,7 @@
"members":{
"StandardsSubscriptions":{
"shape":"StandardsSubscriptions",
"documentation":"<p>A list of <code>StandardsSubscriptions</code> objects that include information about the enabled standards.</p>"
"documentation":"<p>The list of <code>StandardsSubscriptions</code> objects that include information about the enabled standards.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -1836,15 +3039,15 @@
"members":{
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>The findings attributes used to define a condition to filter the findings returned.</p>"
"documentation":"<p>The finding attributes used to define a condition to filter the returned findings.</p>"
},
"SortCriteria":{
"shape":"SortCriteria",
"documentation":"<p>Findings attributes used to sort the list of findings returned.</p>"
"documentation":"<p>The finding attributes used to sort the list of returned findings.</p>"
},
"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>. For subsequent calls to the operation, fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data.</p>"
"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>"
},
"MaxResults":{
"shape":"MaxResults",
@ -1872,7 +3075,7 @@
"members":{
"InsightArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the insight whose results you want to see.</p>",
"documentation":"<p>The ARN of the insight for which to return results.</p>",
"location":"uri",
"locationName":"InsightArn"
}
@ -1893,15 +3096,15 @@
"members":{
"InsightArns":{
"shape":"ArnList",
"documentation":"<p>The ARNs of the insights that you want to describe.</p>"
"documentation":"<p>The ARNs of the insights to describe.</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, fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data.</p>"
"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>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items that you want in the response.</p>"
"documentation":"<p>The maximum number of items to return in the response.</p>"
}
}
},
@ -1929,7 +3132,7 @@
"members":{
"InvitationsCount":{
"shape":"Integer",
"documentation":"<p>The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation. </p>"
"documentation":"<p>The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.</p>"
}
}
},
@ -1953,7 +3156,7 @@
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>A list of account IDs for the Security Hub member accounts that you want to return the details for. </p>"
"documentation":"<p>The list of account IDs for the Security Hub member accounts to return the details for. </p>"
}
}
},
@ -1962,11 +3165,11 @@
"members":{
"Members":{
"shape":"MemberList",
"documentation":"<p>A list of details about the Security Hub member accounts.</p>"
"documentation":"<p>The list of details about the Security Hub member accounts.</p>"
},
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that couldn't be processed.</p>"
"documentation":"<p>The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -1991,7 +3194,7 @@
"documentation":"<p>The message of the error made during the <code>BatchImportFindings</code> operation.</p>"
}
},
"documentation":"<p>Includes details of the list of the findings that can't be imported.</p>"
"documentation":"<p>Includes details of the list of the findings that cannot be imported.</p>"
},
"ImportFindingsErrorList":{
"type":"list",
@ -2016,7 +3219,7 @@
},
"Filters":{
"shape":"AwsSecurityFindingFilters",
"documentation":"<p>One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.</p>"
"documentation":"<p>One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.</p>"
},
"GroupByAttribute":{
"shape":"NonEmptyString",
@ -2122,7 +3325,7 @@
},
"MemberStatus":{
"shape":"NonEmptyString",
"documentation":"<p>The current status of the association between member and master accounts.</p>"
"documentation":"<p>The current status of the association between the member and master accounts.</p>"
}
},
"documentation":"<p>Details about an invitation.</p>"
@ -2136,7 +3339,7 @@
"members":{
"AccountIds":{
"shape":"AccountIdList",
"documentation":"<p>A list of IDs of the AWS accounts that you want to invite to Security Hub as members. </p>"
"documentation":"<p>The list of account IDs of the AWS accounts to invite to Security Hub as members. </p>"
}
}
},
@ -2145,7 +3348,7 @@
"members":{
"UnprocessedAccounts":{
"shape":"ResultList",
"documentation":"<p>A list of account ID and email address pairs of the AWS accounts that couldn't be processed. </p>"
"documentation":"<p>The list of AWS accounts that could not be processed. For each account, the list includes the account ID and the email address.</p>"
}
}
},
@ -2192,13 +3395,13 @@
"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, fill <code>nextToken</code> in the request with the value of <code>NextToken</code> from the previous response to continue listing data.</p>",
"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>",
"location":"querystring",
"locationName":"NextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items that you want in the response.</p>",
"documentation":"<p>The maximum number of items to return in the response.</p>",
"location":"querystring",
"locationName":"MaxResults"
}
@ -2209,7 +3412,7 @@
"members":{
"ProductSubscriptions":{
"shape":"ProductSubscriptionArnList",
"documentation":"<p>A list of ARNs for the resources that represent your subscriptions to products. </p>"
"documentation":"<p>The list of ARNs for the resources that represent your subscriptions to products. </p>"
},
"NextToken":{
"shape":"NextToken",
@ -2222,13 +3425,13 @@
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items that you want in the response. </p>",
"documentation":"<p>The maximum number of items to return in the response. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"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, fill <code>nextToken</code> in the request with the value of <code>NextToken</code> from the previous response to continue listing data. </p>",
"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>",
"location":"querystring",
"locationName":"NextToken"
}
@ -2252,19 +3455,19 @@
"members":{
"OnlyAssociated":{
"shape":"Boolean",
"documentation":"<p>Specifies which member accounts the response includes based on their relationship status with the master account. The default value is <code>TRUE</code>. 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>. 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"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items that you want in the response. </p>",
"documentation":"<p>The maximum number of items to return in the response. </p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Paginates results. Set the value of this parameter to <code>NULL</code> on your first call to the <code>ListMembers</code> operation. For subsequent calls to the operation, fill <code>nextToken</code> in the request with the value of <code>nextToken</code> from the previous response to continue listing data. </p>",
"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>",
"location":"querystring",
"locationName":"NextToken"
}
@ -2304,6 +3507,20 @@
}
}
},
"LoadBalancerState":{
"type":"structure",
"members":{
"Code":{
"shape":"NonEmptyString",
"documentation":"<p>The state code. The initial state of the load balancer is provisioning.</p> <p>After the load balancer is fully set up and ready to route traffic, its state is active.</p> <p>If the load balancer could not be set up, its state is failed. </p>"
},
"Reason":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the state.</p>"
}
},
"documentation":"<p>Information about the state of the load balancer.</p>"
},
"Malware":{
"type":"structure",
"required":["Name"],
@ -2486,6 +3703,10 @@
"type":"string",
"pattern":".*\\S.*"
},
"NonEmptyStringList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Note":{
"type":"structure",
"required":[
@ -2677,6 +3898,10 @@
"type":"list",
"member":{"shape":"RelatedFinding"}
},
"RelatedRequirementsList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Remediation":{
"type":"structure",
"members":{
@ -2696,7 +3921,7 @@
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of the resource that details are provided for.</p>"
"documentation":"<p>The type of the resource that details are provided for. If possible, set <code>Type</code> to one of the supported resource types. For example, if the resource is an EC2 instance, then set <code>Type</code> to <code>AwsEc2Instance</code>.</p> <p>If the resource does not match any of the provided types, then set <code>Type</code> to <code>Other</code>. </p>"
},
"Id":{
"shape":"NonEmptyString",
@ -2738,10 +3963,34 @@
"ResourceDetails":{
"type":"structure",
"members":{
"AwsCodeBuildProject":{
"shape":"AwsCodeBuildProjectDetails",
"documentation":"<p>Details for an AWS CodeBuild project.</p>"
},
"AwsCloudFrontDistribution":{
"shape":"AwsCloudFrontDistributionDetails",
"documentation":"<p>Details about a CloudFront distribution.</p>"
},
"AwsEc2Instance":{
"shape":"AwsEc2InstanceDetails",
"documentation":"<p>Details about an Amazon EC2 instance related to a finding.</p>"
},
"AwsEc2NetworkInterface":{
"shape":"AwsEc2NetworkInterfaceDetails",
"documentation":"<p>Details for an AWS EC2 network interface.</p>"
},
"AwsEc2SecurityGroup":{
"shape":"AwsEc2SecurityGroupDetails",
"documentation":"<p>Details for an EC2 security group.</p>"
},
"AwsElbv2LoadBalancer":{
"shape":"AwsElbv2LoadBalancerDetails",
"documentation":"<p>Details about a load balancer.</p>"
},
"AwsElasticsearchDomain":{
"shape":"AwsElasticsearchDomainDetails",
"documentation":"<p>Details for an Elasticsearch domain.</p>"
},
"AwsS3Bucket":{
"shape":"AwsS3BucketDetails",
"documentation":"<p>Details about an Amazon S3 Bucket related to a finding.</p>"
@ -2750,16 +3999,48 @@
"shape":"AwsIamAccessKeyDetails",
"documentation":"<p>Details about an IAM access key related to a finding.</p>"
},
"AwsIamRole":{
"shape":"AwsIamRoleDetails",
"documentation":"<p>Details about an IAM role.</p>"
},
"AwsKmsKey":{
"shape":"AwsKmsKeyDetails",
"documentation":"<p>Details about a KMS key.</p>"
},
"AwsLambdaFunction":{
"shape":"AwsLambdaFunctionDetails",
"documentation":"<p>Details about a Lambda function.</p>"
},
"AwsLambdaLayerVersion":{
"shape":"AwsLambdaLayerVersionDetails",
"documentation":"<p>Details for a Lambda layer version.</p>"
},
"AwsRdsDbInstance":{
"shape":"AwsRdsDbInstanceDetails",
"documentation":"<p>Details for an RDS database instance.</p>"
},
"AwsSnsTopic":{
"shape":"AwsSnsTopicDetails",
"documentation":"<p>Details about an SNS topic.</p>"
},
"AwsSqsQueue":{
"shape":"AwsSqsQueueDetails",
"documentation":"<p>Details about an SQS queue.</p>"
},
"AwsWafWebAcl":{
"shape":"AwsWafWebAclDetails",
"documentation":"<p>Details for a WAF WebACL.</p>"
},
"Container":{
"shape":"ContainerDetails",
"documentation":"<p>Details about a container resource related to a finding.</p>"
},
"Other":{
"shape":"FieldMap",
"documentation":"<p>Details about a resource that doesn't have a specific type defined.</p>"
"documentation":"<p>Details about a resource that are not available in a type-specific details object. Use the <code>Other</code> object in the following cases.</p> <ul> <li> <p>The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the <code>Other</code> object to populate the fields that are missing from the type-specific object.</p> </li> <li> <p>The resource type does not have a corresponding object. This includes resources for which the type is <code>Other</code>. </p> </li> </ul>"
}
},
"documentation":"<p>Additional details about a resource related to a finding.</p>"
"documentation":"<p>Additional details about a resource related to a finding.</p> <p>To provide the details, use the object that corresponds to the resource type. For example, if the resource type is <code>AwsEc2Instance</code>, then you use the <code>AwsEc2Instance</code> object to provide the details.</p> <p>If the type-specific object does not contain all of the fields you want to populate, then you use the <code>Other</code> object to populate those additional fields.</p> <p>You also use the <code>Other</code> object to populate the details when the selected type does not have a corresponding object.</p>"
},
"ResourceList":{
"type":"list",
@ -2780,19 +4061,23 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>An AWS account ID of the account that wasn't be processed.</p>"
"documentation":"<p>An AWS account ID of the account that was not processed.</p>"
},
"ProcessingResult":{
"shape":"NonEmptyString",
"documentation":"<p>The reason that the account wasn't be processed.</p>"
"documentation":"<p>The reason that the account was not processed.</p>"
}
},
"documentation":"<p>Details about the account that wasn't processed.</p>"
"documentation":"<p>Details about the account that was not processed.</p>"
},
"ResultList":{
"type":"list",
"member":{"shape":"Result"}
},
"SecurityGroups":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Severity":{
"type":"structure",
"required":["Normalized"],
@ -2808,6 +4093,15 @@
},
"documentation":"<p>The severity of the finding.</p>"
},
"SeverityRating":{
"type":"string",
"enum":[
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
]
},
"SortCriteria":{
"type":"list",
"member":{"shape":"SortCriterion"}
@ -2833,6 +4127,52 @@
"desc"
]
},
"StandardsControl":{
"type":"structure",
"members":{
"StandardsControlArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the compliance 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>"
},
"DisabledReason":{
"shape":"NonEmptyString",
"documentation":"<p>The reason provided for the most recent change in status for the control.</p>"
},
"ControlStatusUpdatedAt":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the status of the compliance standard control was most recently updated.</p>"
},
"ControlId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the compliance standard control.</p>"
},
"Title":{
"shape":"NonEmptyString",
"documentation":"<p>The title of the compliance 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>"
},
"RemediationUrl":{
"shape":"NonEmptyString",
"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>Details for an individual compliance standard control.</p>"
},
"StandardsControls":{
"type":"list",
"member":{"shape":"StandardsControl"}
},
"StandardsInputParameterMap":{
"type":"map",
"key":{"shape":"NonEmptyString"},
@ -2988,30 +4328,30 @@
"members":{
"Type":{
"shape":"ThreatIntelIndicatorType",
"documentation":"<p>The type of a threat intel indicator.</p>"
"documentation":"<p>The type of threat intelligence indicator.</p>"
},
"Value":{
"shape":"NonEmptyString",
"documentation":"<p>The value of a threat intel indicator.</p>"
"documentation":"<p>The value of a threat intelligence indicator.</p>"
},
"Category":{
"shape":"ThreatIntelIndicatorCategory",
"documentation":"<p>The category of a threat intel indicator.</p>"
"documentation":"<p>The category of a threat intelligence indicator.</p>"
},
"LastObservedAt":{
"shape":"NonEmptyString",
"documentation":"<p>The date and time when the most recent instance of a threat intel indicator was observed.</p>"
"documentation":"<p>The date and time when the most recent instance of a threat intelligence indicator was observed.</p>"
},
"Source":{
"shape":"NonEmptyString",
"documentation":"<p>The source of the threat intel indicator.</p>"
"documentation":"<p>The source of the threat intelligence indicator.</p>"
},
"SourceUrl":{
"shape":"NonEmptyString",
"documentation":"<p>The URL to the page or site where you can get more information about the threat intel indicator.</p>"
"documentation":"<p>The URL to the page or site where you can get more information about the threat intelligence indicator.</p>"
}
},
"documentation":"<p>Details about the threat intel related to a finding.</p>"
"documentation":"<p>Details about the threat intelligence related to a finding.</p>"
},
"ThreatIntelIndicatorCategory":{
"type":"string",
@ -3155,6 +4495,31 @@
"members":{
}
},
"UpdateStandardsControlRequest":{
"type":"structure",
"required":["StandardsControlArn"],
"members":{
"StandardsControlArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the compliance 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>"
},
"DisabledReason":{
"shape":"NonEmptyString",
"documentation":"<p>A description of the reason why you are disabling a compliance standard control.</p>"
}
}
},
"UpdateStandardsControlResponse":{
"type":"structure",
"members":{
}
},
"VerificationState":{
"type":"string",
"enum":[
@ -3164,6 +4529,40 @@
"BENIGN_POSITIVE"
]
},
"WafAction":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>Specifies how you want AWS WAF to respond to requests that match the settings in a Rule.</p> <p>Valid settings include the following:</p> <ul> <li> <p> <code>ALLOW</code> - AWS WAF allows requests</p> </li> <li> <p> <code>BLOCK</code> - AWS WAF blocks requests</p> </li> <li> <p> <code>COUNT</code> - AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a WebACL.</p> </li> </ul>"
}
},
"documentation":"<p>Details about the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. </p>"
},
"WafExcludedRule":{
"type":"structure",
"members":{
"RuleId":{
"shape":"NonEmptyString",
"documentation":"<p>The unique identifier for the rule to exclude from the rule group.</p>"
}
},
"documentation":"<p>Details about a rule to exclude from a rule group.</p>"
},
"WafExcludedRuleList":{
"type":"list",
"member":{"shape":"WafExcludedRule"}
},
"WafOverrideAction":{
"type":"structure",
"members":{
"Type":{
"shape":"NonEmptyString",
"documentation":"<p> <code>COUNT</code> overrides the action specified by the individual rule within a RuleGroup .</p> <p>If set to <code>NONE</code>, the rule's action takes place.</p>"
}
},
"documentation":"<p>Details about an override action for a rule.</p>"
},
"WorkflowState":{
"type":"string",
"enum":[
@ -3175,5 +4574,5 @@
]
}
},
"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. 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 us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invite was sent from.</p>"
"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>"
}

View file

@ -84,7 +84,7 @@
{"shape":"BadRequestException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES API v2 then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the <code>GetDeliverabilityTestReport</code> operation to view the results of the test.</p>"
"documentation":"<p>Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon SES then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the <code>GetDeliverabilityTestReport</code> operation to view the results of the test.</p>"
},
"CreateEmailIdentity":{
"name":"CreateEmailIdentity",
@ -95,12 +95,13 @@
"input":{"shape":"CreateEmailIdentityRequest"},
"output":{"shape":"CreateEmailIdentityResponse"},
"errors":[
{"shape":"AlreadyExistsException"},
{"shape":"LimitExceededException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Starts the process of verifying an email identity. An <i>identity</i> is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.</p> <p>When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. </p> <p>When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. For some DNS providers, it can take 72 hours or more to complete the domain verification process.</p>"
"documentation":"<p>Starts the process of verifying an email identity. An <i>identity</i> is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.</p> <p>When you verify an email address, Amazon SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. </p> <p>When you verify a domain without specifying the <code>DkimSigningAttributes</code> object, this operation provides a set of DKIM tokens. You can convert these tokens into CNAME records, which you then add to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> <p>Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your call to the <code>CreateEmailIdentity</code> operation has to include the <code>DkimSigningAttributes</code> object. When you specify this object, you provide a selector (a component of the DNS record name that identifies the public key that you want to use for DKIM authentication) and a private key.</p>"
},
"DeleteConfigurationSet":{
"name":"DeleteConfigurationSet",
@ -178,7 +179,7 @@
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Used to delete a suppressed email destination from your suppression list.</p>"
"documentation":"<p>Removes an email address from the suppression list for your account.</p>"
},
"GetAccount":{
"name":"GetAccount",
@ -282,7 +283,7 @@
{"shape":"LimitExceededException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/pinpoint/pricing/\">Amazon Pinpoint Pricing</a>.</p>"
"documentation":"<p>Retrieve information about the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/ses/pricing/\">Amazon SES Pricing</a>.</p>"
},
"GetDeliverabilityTestReport":{
"name":"GetDeliverabilityTestReport",
@ -357,7 +358,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Used to fetch a single suppressed email destination from your suppression list.</p>"
"documentation":"<p>Retrieves information about a specific email address that's on the suppression list for your account.</p>"
},
"ListConfigurationSets":{
"name":"ListConfigurationSets",
@ -444,7 +445,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Used to fetch a list suppressed email destinations from your suppression list.</p>"
"documentation":"<p>Retrieves a list of email addresses that are on the suppression list for your account.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -501,7 +502,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Change your account's suppression preferences for your account.</p>"
"documentation":"<p>Change the settings for the account-level suppression list.</p>"
},
"PutConfigurationSetDeliveryOptions":{
"name":"PutConfigurationSetDeliveryOptions",
@ -561,7 +562,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Specify your account's suppression preferences for a configuration set.</p>"
"documentation":"<p>Specify the account suppression list preferences for a configuration set.</p>"
},
"PutConfigurationSetTrackingOptions":{
"name":"PutConfigurationSetTrackingOptions",
@ -623,7 +624,7 @@
{"shape":"LimitExceededException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/pinpoint/pricing/\">Amazon Pinpoint Pricing</a>.</p>"
"documentation":"<p>Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email. You also gain the ability to perform predictive inbox placement tests.</p> <p>When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon SES and other AWS services. For more information about the features and cost of a Deliverability dashboard subscription, see <a href=\"http://aws.amazon.com/ses/pricing/\">Amazon SES Pricing</a>.</p>"
},
"PutEmailIdentityDkimAttributes":{
"name":"PutEmailIdentityDkimAttributes",
@ -640,6 +641,21 @@
],
"documentation":"<p>Used to enable or disable DKIM authentication for an email identity.</p>"
},
"PutEmailIdentityDkimSigningAttributes":{
"name":"PutEmailIdentityDkimSigningAttributes",
"http":{
"method":"PUT",
"requestUri":"/v1/email/identities/{EmailIdentity}/dkim/signing"
},
"input":{"shape":"PutEmailIdentityDkimSigningAttributesRequest"},
"output":{"shape":"PutEmailIdentityDkimSigningAttributesResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:</p> <ul> <li> <p>Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).</p> </li> <li> <p>Change from using no DKIM authentication to using Easy DKIM.</p> </li> <li> <p>Change from using no DKIM authentication to using BYODKIM.</p> </li> <li> <p>Change from using Easy DKIM to using BYODKIM.</p> </li> <li> <p>Change from using BYODKIM to using Easy DKIM.</p> </li> </ul>"
},
"PutEmailIdentityFeedbackAttributes":{
"name":"PutEmailIdentityFeedbackAttributes",
"http":{
@ -682,7 +698,7 @@
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Puts (overwrites) an email destination in your suppression list.</p>"
"documentation":"<p>Adds an email address to the suppression list for your account.</p>"
},
"SendEmail":{
"name":"SendEmail",
@ -702,7 +718,7 @@
{"shape":"NotFoundException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Sends an email message. You can use the Amazon SES API v2 to send two types of messages:</p> <ul> <li> <p> <b>Simple</b> A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and the Amazon SES API v2 assembles the message for you.</p> </li> <li> <p> <b>Raw</b> A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.</p> </li> </ul>"
"documentation":"<p>Sends an email message. You can use the Amazon SES API v2 to send two types of messages:</p> <ul> <li> <p> <b>Simple</b> A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon SES assembles the message for you.</p> </li> <li> <p> <b>Raw</b> A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.</p> </li> </ul>"
},
"TagResource":{
"name":"TagResource",
@ -905,7 +921,7 @@
},
"Charset":{
"shape":"Charset",
"documentation":"<p>The character set for the content. Because of the constraints of the SMTP protocol, the Amazon SES API v2 uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.</p>"
"documentation":"<p>The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify <code>UTF-8</code>, <code>ISO-8859-1</code>, or <code>Shift_JIS</code>.</p>"
}
},
"documentation":"<p>An object that represents the content of the email, and optionally a character set specification.</p>"
@ -1055,6 +1071,10 @@
"Tags":{
"shape":"TagList",
"documentation":"<p>An array of objects that define the tags (keys and values) that you want to associate with the email identity.</p>"
},
"DkimSigningAttributes":{
"shape":"DkimSigningAttributes",
"documentation":"<p>If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, as opposed to the default method, <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> <p>You can only specify this object if the email identity is a domain, as opposed to an address.</p>"
}
},
"documentation":"<p>A request to begin the verification process for an email identity (an email address or domain).</p>"
@ -1072,10 +1092,10 @@
},
"DkimAttributes":{
"shape":"DkimAttributes",
"documentation":"<p>An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.</p>"
"documentation":"<p>An object that contains information about the DKIM attributes for the identity.</p>"
}
},
"documentation":"<p>If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.</p> <p>If the email identity is an email address, this object is empty. </p>"
"documentation":"<p>If the email identity is a domain, this object contains information about the DKIM verification status for the domain.</p> <p>If the email identity is an email address, this object is empty. </p>"
},
"CustomRedirectDomain":{
"type":"string",
@ -1128,7 +1148,7 @@
"documentation":"<p>The name of the dedicated IP pool that the IP address is associated with.</p>"
}
},
"documentation":"<p>Contains information about a dedicated IP address that is associated with your Amazon SES API v2 account.</p> <p>To learn more about requesting dedicated IP addresses, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html\">Requesting and Relinquishing Dedicated IP Addresses</a> in the <i>Amazon SES Developer Guide</i>.</p>"
"documentation":"<p>Contains information about a dedicated IP address that is associated with your Amazon SES account.</p> <p>To learn more about requesting dedicated IP addresses, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/dedicated-ip-case.html\">Requesting and Relinquishing Dedicated IP Addresses</a> in the <i>Amazon SES Developer Guide</i>.</p>"
},
"DedicatedIpList":{
"type":"list",
@ -1230,12 +1250,12 @@
"members":{
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>The suppressed email destination to delete.</p>",
"documentation":"<p>The suppressed email destination to remove from the account suppression list.</p>",
"location":"uri",
"locationName":"EmailAddress"
}
},
"documentation":"<p>A request to delete a suppressed email destination.</p>"
"documentation":"<p>A request to remove an email address from the suppression list for your account.</p>"
},
"DeleteSuppressedDestinationResponse":{
"type":"structure",
@ -1352,18 +1372,47 @@
},
"Status":{
"shape":"DkimStatus",
"documentation":"<p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.</p> </li> <li> <p> <code>SUCCESS</code> Amazon SES located the DKIM records in the DNS configuration for the domain and determined that they're correct. You can now send DKIM-signed email from the identity.</p> </li> <li> <p> <code>FAILED</code> Amazon SES wasn't able to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> A temporary issue occurred, which prevented Amazon SES from determining the DKIM status for the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> Amazon SES hasn't yet started searching for the DKIM records in the DKIM records for the domain.</p> </li> </ul>"
"documentation":"<p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> The DKIM verification process hasn't been initiated for the domain.</p> </li> </ul>"
},
"Tokens":{
"shape":"DnsTokenList",
"documentation":"<p>A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon SES usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.</p>"
"documentation":"<p>If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.</p> <p>If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.</p> <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.</p>"
},
"SigningAttributesOrigin":{
"shape":"DkimSigningAttributesOrigin",
"documentation":"<p>A string that indicates how DKIM was configured for the identity. There are two possible values:</p> <ul> <li> <p> <code>AWS_SES</code> Indicates that DKIM was configured for the identity by using <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> </li> <li> <p> <code>EXTERNAL</code> Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).</p> </li> </ul>"
}
},
"documentation":"<p>An object that contains information about the DKIM configuration for an email identity.</p>"
"documentation":"<p>An object that contains information about the DKIM authentication status for an email identity.</p> <p>Amazon SES determines the authentication status by searching for specific records in the DNS configuration for the domain. If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain. If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity</p>"
},
"DkimSigningAttributes":{
"type":"structure",
"required":[
"DomainSigningSelector",
"DomainSigningPrivateKey"
],
"members":{
"DomainSigningSelector":{
"shape":"Selector",
"documentation":"<p>A string that's used to identify a public key in the DNS configuration for a domain.</p>"
},
"DomainSigningPrivateKey":{
"shape":"PrivateKey",
"documentation":"<p>A private key that's used to generate a DKIM signature.</p> <p>The private key must use 1024-bit RSA encryption, and must be encoded using base64 encoding.</p>"
}
},
"documentation":"<p>An object that contains information about the tokens used for setting up Bring Your Own DKIM (BYODKIM).</p>"
},
"DkimSigningAttributesOrigin":{
"type":"string",
"enum":[
"AWS_SES",
"EXTERNAL"
]
},
"DkimStatus":{
"type":"string",
"documentation":"<p>The DKIM authentication status of the identity. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> The DKIM verification process was initiated, and Amazon SES hasn't yet detected the CNAME records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> The DKIM authentication process completed successfully.</p> </li> <li> <p> <code>FAILED</code> The DKIM authentication process failed. This can happen when Amazon SES fails to find the required CNAME records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> The DKIM verification process hasn't been initiated for the domain.</p> </li> </ul>",
"documentation":"<p>The DKIM authentication status of the identity. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> The DKIM verification process hasn't been initiated for the domain.</p> </li> </ul>",
"enum":[
"PENDING",
"SUCCESS",
@ -1654,7 +1703,7 @@
},
"SuppressionAttributes":{
"shape":"SuppressionAttributes",
"documentation":"<p>An object that contains information about your account's suppression preferences.</p>"
"documentation":"<p>An object that contains information about the email address suppression preferences for your account in the current AWS Region.</p>"
}
},
"documentation":"<p>A list of details about the email-sending capabilities of your Amazon SES account in the current AWS Region.</p>"
@ -1748,7 +1797,7 @@
},
"SuppressionOptions":{
"shape":"SuppressionOptions",
"documentation":"<p>An object that contains information about your account's suppression preferences.</p>"
"documentation":"<p>An object that contains information about the suppression list preferences for your account.</p>"
}
},
"documentation":"<p>Information about a configuration set.</p>"
@ -1992,7 +2041,7 @@
},
"DkimAttributes":{
"shape":"DkimAttributes",
"documentation":"<p>An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.</p>"
"documentation":"<p>An object that contains information about the DKIM attributes for the identity.</p>"
},
"MailFromAttributes":{
"shape":"MailFromAttributes",
@ -2011,12 +2060,12 @@
"members":{
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>Email destination to fetch from the suppression list.</p>",
"documentation":"<p>The email address that's on the account suppression list.</p>",
"location":"uri",
"locationName":"EmailAddress"
}
},
"documentation":"<p>A request to get a suppressed email destination.</p>"
"documentation":"<p>A request to retrieve information about an email address that's on the suppression list for your account.</p>"
},
"GetSuppressedDestinationResponse":{
"type":"structure",
@ -2024,10 +2073,10 @@
"members":{
"SuppressedDestination":{
"shape":"SuppressedDestination",
"documentation":"<p>An object containing information about the suppressed email destination.</p>"
"documentation":"<p>An object containing information about the suppressed email address.</p>"
}
},
"documentation":"<p>Information about the suppressed email destination.</p>"
"documentation":"<p>Information about the suppressed email address.</p>"
},
"Identity":{"type":"string"},
"IdentityInfo":{
@ -2080,7 +2129,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified request includes an invalid or expired token. Please attempt to get a new token.</p>",
"documentation":"<p>The specified request includes an invalid or expired token.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -2343,25 +2392,25 @@
"members":{
"Reasons":{
"shape":"SuppressionListReasons",
"documentation":"<p>Filters email destinations suppressed by the given reasons.</p>",
"documentation":"<p>The factors that caused the email address to be added to .</p>",
"location":"querystring",
"locationName":"Reason"
},
"StartDate":{
"shape":"Timestamp",
"documentation":"<p>Filters email destinations suppressed before the given time.</p>",
"documentation":"<p>Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.</p>",
"location":"querystring",
"locationName":"StartDate"
},
"EndDate":{
"shape":"Timestamp",
"documentation":"<p>Filters email destinations suppressed after the given time.</p>",
"documentation":"<p>Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.</p>",
"location":"querystring",
"locationName":"EndDate"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to indicate the position in the list of suppressed email destinations.</p>",
"documentation":"<p>A token returned from a previous call to <code>ListSuppressedDestinations</code> to indicate the position in the list of suppressed email addresses.</p>",
"location":"querystring",
"locationName":"NextToken"
},
@ -2372,7 +2421,7 @@
"locationName":"PageSize"
}
},
"documentation":"<p>A request to obtain a list of suppressed email destinations.</p>"
"documentation":"<p>A request to obtain a list of email destinations that are on the suppression list for your account.</p>"
},
"ListSuppressedDestinationsResponse":{
"type":"structure",
@ -2383,10 +2432,10 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token that indicates that there are additional suppressed destinations to list. To view additional suppressed destinations, issue another request to <code>ListSuppressedDestinations</code>, and pass this token in the <code>NextToken</code> parameter.</p>"
"documentation":"<p>A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to <code>ListSuppressedDestinations</code>, and pass this token in the <code>NextToken</code> parameter.</p>"
}
},
"documentation":"<p>A list of suppressed email destinations.</p>"
"documentation":"<p>A list of suppressed email addresses.</p>"
},
"ListTagsForResourceRequest":{
"type":"structure",
@ -2593,6 +2642,13 @@
"type":"string",
"documentation":"<p>The name of a dedicated IP pool.</p>"
},
"PrivateKey":{
"type":"string",
"max":20480,
"min":1,
"pattern":"^[a-zA-Z0-9+\\/]+={0,2}$",
"sensitive":true
},
"PutAccountDedicatedIpWarmupAttributesRequest":{
"type":"structure",
"members":{
@ -2630,7 +2686,7 @@
"members":{
"SuppressedReasons":{
"shape":"SuppressionListReasons",
"documentation":"<p>A list of reasons to suppress email addresses. The only valid reasons are:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES will suppress an email address that receives a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES will suppress an email address that hard bounces.</p> </li> </ul>"
"documentation":"<p>A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>"
}
},
"documentation":"<p>A request to change your account's suppression preferences.</p>"
@ -2720,16 +2776,16 @@
"members":{
"ConfigurationSetName":{
"shape":"ConfigurationSetName",
"documentation":"<p>The name of the configuration set that you want to enable or disable email sending for.</p>",
"documentation":"<p>The name of the configuration set that you want to change the suppression list preferences for.</p>",
"location":"uri",
"locationName":"ConfigurationSetName"
},
"SuppressedReasons":{
"shape":"SuppressionListReasons",
"documentation":"<p>A list of reasons to suppress email addresses. The only valid reasons are:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES will suppress an email address that receives a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES will suppress an email address that hard bounces.</p> </li> </ul>"
"documentation":"<p>A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>"
}
},
"documentation":"<p>A request to change your account's suppression preferences for an specific configuration set.</p>"
"documentation":"<p>A request to change the account suppression list preferences for a specific configuration set.</p>"
},
"PutConfigurationSetSuppressionOptionsResponse":{
"type":"structure",
@ -2856,6 +2912,44 @@
},
"documentation":"<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>"
},
"PutEmailIdentityDkimSigningAttributesRequest":{
"type":"structure",
"required":[
"EmailIdentity",
"SigningAttributesOrigin"
],
"members":{
"EmailIdentity":{
"shape":"Identity",
"documentation":"<p>The email identity that you want to configure DKIM for.</p>",
"location":"uri",
"locationName":"EmailIdentity"
},
"SigningAttributesOrigin":{
"shape":"DkimSigningAttributesOrigin",
"documentation":"<p>The method that you want to use to configure DKIM for the identity. There are two possible values:</p> <ul> <li> <p> <code>AWS_SES</code> Configure DKIM for the identity by using <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a>.</p> </li> <li> <p> <code>EXTERNAL</code> Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).</p> </li> </ul>"
},
"SigningAttributes":{
"shape":"DkimSigningAttributes",
"documentation":"<p>An object that contains information about the private key and selector that you want to use to configure DKIM for the identity. This object is only required if you want to configure Bring Your Own DKIM (BYODKIM) for the identity.</p>"
}
},
"documentation":"<p>A request to change the DKIM attributes for an email identity.</p>"
},
"PutEmailIdentityDkimSigningAttributesResponse":{
"type":"structure",
"members":{
"DkimStatus":{
"shape":"DkimStatus",
"documentation":"<p>The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.</p> <p>If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.</p> <p>The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> The DKIM verification process hasn't been initiated for the domain.</p> </li> </ul>"
},
"DkimTokens":{
"shape":"DnsTokenList",
"documentation":"<p>If you used <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Easy DKIM</a> to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.</p> <p>If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.</p> <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.</p>"
}
},
"documentation":"<p>If the action is successful, the service sends back an HTTP 200 response.</p> <p>The following data is returned in JSON format by the service.</p>"
},
"PutEmailIdentityFeedbackAttributesRequest":{
"type":"structure",
"required":["EmailIdentity"],
@ -2915,14 +3009,14 @@
"members":{
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>Email destination to be suppressed.</p>"
"documentation":"<p>The email address that should be added to the suppression list for your account.</p>"
},
"Reason":{
"shape":"SuppressionListReason",
"documentation":"<p>Reason for which the email destination is suppressed.</p>"
"documentation":"<p>The factors that should cause the email address to be added to the suppression list for your account.</p>"
}
},
"documentation":"<p>A request to suppress an email destination.</p>"
"documentation":"<p>A request to add an email destination to the suppression list for your account.</p>"
},
"PutSuppressedDestinationResponse":{
"type":"structure",
@ -2936,10 +3030,10 @@
"members":{
"Data":{
"shape":"RawMessageData",
"documentation":"<p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>Attachments must be in a file format that the Amazon SES API v2 supports. </p> </li> <li> <p>The entire message must be Base64 encoded.</p> </li> <li> <p>If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.</p> </li> <li> <p>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>.</p> </li> </ul>"
"documentation":"<p>The raw email message. The message has to meet the following criteria:</p> <ul> <li> <p>The message has to contain a header and a body, separated by one blank line.</p> </li> <li> <p>All of the required header fields must be present in the message.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>Attachments must be in a file format that the Amazon SES supports.</p> </li> <li> <p>The entire message must be Base64 encoded.</p> </li> <li> <p>If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.</p> </li> <li> <p>The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in <a href=\"https://tools.ietf.org/html/rfc5321\">RFC 5321</a>.</p> </li> </ul>"
}
},
"documentation":"<p>The raw email message.</p>"
"documentation":"<p>Represents the raw content of an email message.</p>"
},
"RawMessageData":{
"type":"blob",
@ -2971,6 +3065,12 @@
},
"documentation":"<p>Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region. </p>"
},
"Selector":{
"type":"string",
"max":63,
"min":1,
"pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9]))$"
},
"SendEmailRequest":{
"type":"structure",
"required":[
@ -3014,7 +3114,7 @@
"members":{
"MessageId":{
"shape":"OutboundMessageId",
"documentation":"<p>A unique identifier for the message that is generated when the message is accepted.</p> <note> <p>It is possible for the Amazon SES API v2 to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.</p> </note>"
"documentation":"<p>A unique identifier for the message that is generated when the message is accepted.</p> <note> <p>It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.</p> </note>"
}
},
"documentation":"<p>A unique message ID that you receive when an email is accepted for sending.</p>"
@ -3082,36 +3182,36 @@
"members":{
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>The suppressed email destination.</p>"
"documentation":"<p>The email address that is on the suppression list for your account.</p>"
},
"Reason":{
"shape":"SuppressionListReason",
"documentation":"<p>The reason for which the email destination is suppressed.</p>"
"documentation":"<p>The reason that the address was added to the suppression list for your account.</p>"
},
"LastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The last time the suppressed destination was updated.</p>"
"documentation":"<p>The date and time when the suppressed destination was last updated, shown in Unix time format.</p>"
},
"Attributes":{
"shape":"SuppressedDestinationAttributes",
"documentation":"<p> <code>Optional</code> value with information about the sources of the suppression.</p>"
"documentation":"<p>An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.</p>"
}
},
"documentation":"<p>An object containing information about the suppressed email destination.</p>"
"documentation":"<p>An object that contains information about an email address that is on the suppression list for your account.</p>"
},
"SuppressedDestinationAttributes":{
"type":"structure",
"members":{
"MessageId":{
"shape":"OutboundMessageId",
"documentation":"<p>A unique identifier of the message that caused the suppression of the email destination.</p>"
"documentation":"<p>The unique identifier of the email message that caused the email address to be added to the suppression list for your account.</p>"
},
"FeedbackId":{
"shape":"FeedbackId",
"documentation":"<p>A unique identifier of the suppression cause.</p>"
"documentation":"<p>A unique identifier that's generated when an email address is added to the suppression list for your account.</p>"
}
},
"documentation":"<p>An object containing additional attributes related to a suppressed destination.</p>"
"documentation":"<p>An object that contains additional attributes that are related an email address that is on the suppression list for your account.</p>"
},
"SuppressedDestinationSummaries":{
"type":"list",
@ -3127,32 +3227,32 @@
"members":{
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"<p>The suppressed email destination.</p>"
"documentation":"<p>The email address that's on the suppression list for your account.</p>"
},
"Reason":{
"shape":"SuppressionListReason",
"documentation":"<p>The reason for which the email destination is suppressed.</p>"
"documentation":"<p>The reason that the address was added to the suppression list for your account.</p>"
},
"LastUpdateTime":{
"shape":"Timestamp",
"documentation":"<p>The last time the suppressed destination was updated.</p>"
"documentation":"<p>The date and time when the suppressed destination was last updated, shown in Unix time format.</p>"
}
},
"documentation":"<p>A summary for the suppressed email destination.</p>"
"documentation":"<p>A summary that describes the suppressed email address.</p>"
},
"SuppressionAttributes":{
"type":"structure",
"members":{
"SuppressedReasons":{
"shape":"SuppressionListReasons",
"documentation":"<p>A list of reasons to suppress email addresses. The only valid reasons are:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES will suppress an email address that receives a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES will suppress an email address that hard bounces.</p> </li> </ul>"
"documentation":"<p>A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>"
}
},
"documentation":"<p>An object that contains information about your account's suppression preferences.</p>"
"documentation":"<p>An object that contains information about the email address suppression preferences for your account in the current AWS Region.</p>"
},
"SuppressionListReason":{
"type":"string",
"documentation":"<p>A string representing the cause for suppression for an email destination. It can be one of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES will suppress an email address that receive a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES will suppress an email address that hard bounces.</p> </li> </ul>",
"documentation":"<p>The reason that the address was added to the suppression list for your account. The value can be one of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES added an email address to the suppression list for your account because a message sent to that address results in a hard bounce.</p> </li> </ul>",
"enum":[
"BOUNCE",
"COMPLAINT"
@ -3167,10 +3267,10 @@
"members":{
"SuppressedReasons":{
"shape":"SuppressionListReasons",
"documentation":"<p>A list of reasons to suppress email addresses. The only valid reasons are:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES will suppress an email address that receives a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES will suppress an email address that hard bounces.</p> </li> </ul>"
"documentation":"<p>A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:</p> <ul> <li> <p> <code>COMPLAINT</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.</p> </li> <li> <p> <code>BOUNCE</code> Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.</p> </li> </ul>"
}
},
"documentation":"<p>An object that contains information about your account's suppression preferences.</p>"
"documentation":"<p>An object that contains information about the suppression list preferences for your account.</p>"
},
"Tag":{
"type":"structure",

View file

@ -71,7 +71,7 @@
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<p>Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html\">Setting Up AWS Systems Manager for Hybrid Environments</a>.</p>"
"documentation":"<p>Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html\">Setting Up AWS Systems Manager for Hybrid Environments</a> in the <i>AWS Systems Manager User Guide</i>. </p> <note> <p>On-premises servers or VMs that are registered with Systems Manager and Amazon EC2 instances that you manage with Systems Manager are all called <i>managed instances</i>.</p> </note>"
},
"CreateAssociation":{
"name":"CreateAssociation",
@ -197,7 +197,7 @@
{"shape":"ResourceDataSyncAlreadyExistsException"},
{"shape":"ResourceDataSyncInvalidConfigurationException"}
],
"documentation":"<p>A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and <code>SyncFromSource</code>.</p> <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring Resource Data Sync for Inventory</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>You can configure Systems Manager Explorer to use the <code>SyncToDestination</code> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. You can also configure Explorer to use the <code>SyncFromSource</code> type. This type synchronizes OpsItems and OpsData from multiple AWS accounts and Regions by using AWS Organizations. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting Up Explorer to Display Data from Multiple Accounts and Regions</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the <a>ListResourceDataSync</a>.</p> <note> <p>By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p> </note>"
"documentation":"<p>A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and <code>SyncFromSource</code>.</p> <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html\">Configuring Resource Data Sync for Inventory</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or <code>EntireOrganization</code> by using AWS Organizations. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html\">Setting Up Explorer to Display Data from Multiple Accounts and Regions</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the <a>ListResourceDataSync</a>.</p> <note> <p>By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. </p> </note>"
},
"DeleteActivation":{
"name":"DeleteActivation",
@ -1249,7 +1249,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidNextToken"}
],
"documentation":"<p>Lists the associations for the specified Systems Manager document or instance.</p>"
"documentation":"<p>Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.</p>"
},
"ListCommandInvocations":{
"name":"ListCommandInvocations",
@ -1345,7 +1345,7 @@
{"shape":"InvalidNextToken"},
{"shape":"InvalidFilterKey"}
],
"documentation":"<p>Describes one or more of your Systems Manager documents.</p>"
"documentation":"<p>Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.</p>"
},
"ListInventoryEntries":{
"name":"ListInventoryEntries",
@ -2699,7 +2699,7 @@
},
"Values":{
"shape":"AttachmentsSourceValues",
"documentation":"<p>The value of a key-value pair that identifies the location of an attachment to a document. The format is the URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.</p>"
"documentation":"<p>The value of a key-value pair that identifies the location of an attachment to a document. The format for <b>Value</b> depends on the type of key you specify.</p> <ul> <li> <p>For the key <i>SourceUrl</i>, the value is an S3 bucket location. For example:</p> <p> <code>\"Values\": [ \"s3://my-bucket/my-folder\" ]</code> </p> </li> <li> <p>For the key <i>S3FileUrl</i>, the value is a file in an S3 bucket. For example:</p> <p> <code>\"Values\": [ \"s3://my-bucket/my-folder/my-file.py\" ]</code> </p> </li> <li> <p>For the key <i>AttachmentReference</i>, the value is constructed from the name of another SSM document in your account, a version number of that document, and a file attached to that document version that you want to reuse. For example:</p> <p> <code>\"Values\": [ \"MyOtherDocument/3/my-other-file.py\" ]</code> </p> <p>However, if the SSM document is shared with you from another account, the full SSM document ARN must be specified instead of the document name only. For example:</p> <p> <code>\"Values\": [ \"arn:aws:ssm:us-east-2:111122223333:document/OtherAccountDocument/3/their-file.py\" ]</code> </p> </li> </ul>"
},
"Name":{
"shape":"AttachmentIdentifier",
@ -2712,7 +2712,8 @@
"type":"string",
"enum":[
"SourceUrl",
"S3FileUrl"
"S3FileUrl",
"AttachmentReference"
]
},
"AttachmentsSourceList":{
@ -2897,7 +2898,8 @@
"CurrentAction",
"StartTimeBefore",
"StartTimeAfter",
"AutomationType"
"AutomationType",
"TagKey"
]
},
"AutomationExecutionFilterList":{
@ -2947,11 +2949,11 @@
},
"AutomationExecutionStatus":{
"shape":"AutomationExecutionStatus",
"documentation":"<p>The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.</p>"
"documentation":"<p>The status of the execution.</p>"
},
"ExecutionStartTime":{
"shape":"DateTime",
"documentation":"<p>The time the execution started.&gt;</p>"
"documentation":"<p>The time the execution started.</p>"
},
"ExecutionEndTime":{
"shape":"DateTime",
@ -3171,8 +3173,7 @@
"CloudWatchLogGroupName":{
"type":"string",
"max":512,
"min":1,
"pattern":"[\\.\\-_/#A-Za-z0-9]+"
"min":1
},
"CloudWatchOutputConfig":{
"type":"structure",
@ -3793,15 +3794,15 @@
"members":{
"Description":{
"shape":"ActivationDescription",
"documentation":"<p>A user-defined description of the resource that you want to register with Amazon EC2. </p> <important> <p>Do not enter personally identifiable information in this field.</p> </important>"
"documentation":"<p>A user-defined description of the resource that you want to register with Systems Manager. </p> <important> <p>Do not enter personally identifiable information in this field.</p> </important>"
},
"DefaultInstanceName":{
"shape":"DefaultInstanceName",
"documentation":"<p>The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.</p> <important> <p>Do not enter personally identifiable information in this field.</p> </important>"
"documentation":"<p>The name of the registered, managed instance as it will appear in the Systems Manager console or when you use the AWS command line tools to list Systems Manager resources.</p> <important> <p>Do not enter personally identifiable information in this field.</p> </important>"
},
"IamRole":{
"shape":"IamRole",
"documentation":"<p>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. </p>"
"documentation":"<p>The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance. This IAM role must provide AssumeRole permissions for the Systems Manager service principal <code>ssm.amazonaws.com</code>. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html\">Create an IAM Service Role for a Hybrid Environment</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"RegistrationLimit":{
"shape":"RegistrationLimit",
@ -3928,7 +3929,7 @@
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. If you use the parameter <code>InstanceId</code>, you cannot use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>"
"documentation":"<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. Requests that include the parameter <code>InstanceID</code> with SSM documents that use schema version 2.0 or later will fail. In addition, if you use the parameter <code>InstanceId</code>, you cannot use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>"
},
"Parameters":{
"shape":"Parameters",
@ -4006,11 +4007,11 @@
},
"DocumentType":{
"shape":"DocumentType",
"documentation":"<p>The type of document to create. Valid document types include: <code>Command</code>, <code>Policy</code>, <code>Automation</code>, <code>Session</code>, and <code>Package</code>.</p>"
"documentation":"<p>The type of document to create.</p>"
},
"DocumentFormat":{
"shape":"DocumentFormat",
"documentation":"<p>Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.</p>"
"documentation":"<p>Specify the document format for the request. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>"
},
"TargetType":{
"shape":"TargetType",
@ -5594,7 +5595,7 @@
},
"InstancesWithInstalledPendingRebootPatches":{
"shape":"InstancesCount",
"documentation":"<p>Reserved for future use. </p>",
"documentation":"<p>The number of instances with patches installed by Patch Manager that have not been rebooted after the patch installation. The status of these instances is NON_COMPLIANT.</p>",
"box":true
},
"InstancesWithInstalledRejectedPatches":{
@ -6183,7 +6184,7 @@
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.</p> <p>For information about resource limits in Systems Manager, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm\">AWS Systems Manager Limits</a>.</p>",
"documentation":"<p>Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.</p> <p>For information about resource quotas in Systems Manager, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm\">Systems Manager Service Quotas</a> in the <i>AWS General Reference</i>.</p>",
"exception":true
},
"DryRun":{"type":"boolean"},
@ -7754,7 +7755,7 @@
},
"InstalledPendingRebootCount":{
"shape":"PatchInstalledPendingRebootCount",
"documentation":"<p>Reserved for future use.</p>",
"documentation":"<p>The number of patches installed by Patch Manager since the last time the instance was rebooted.</p>",
"box":true
},
"InstalledRejectedCount":{
@ -7793,11 +7794,11 @@
},
"LastNoRebootInstallOperationTime":{
"shape":"DateTime",
"documentation":"<p>Reserved for future use. </p>"
"documentation":"<p>The time of the last attempt to patch the instance with <code>NoReboot</code> specified as the reboot option.</p>"
},
"RebootOption":{
"shape":"RebootOption",
"documentation":"<p>Reserved for future use. </p>"
"documentation":"<p>Indicates the reboot option specified in the patch baseline.</p> <note> <p>Reboot options apply to <code>Install</code> operations only. Reboots are not attempted for Patch Manager <code>Scan</code> operations.</p> </note> <ul> <li> <p> <b>RebootIfNeeded</b>: Patch Manager tries to reboot the instance if it installed any patches, or if any patches are detected with a status of <code>InstalledPendingReboot</code>.</p> </li> <li> <p> <b>NoReboot</b>: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of <code>InstalledPendingReboot</code>. These patches might not be in effect until a reboot is performed.</p> </li> </ul>"
}
},
"documentation":"<p>Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.</p>"
@ -8400,7 +8401,7 @@
},
"Type":{
"shape":"InventoryQueryOperatorType",
"documentation":"<p>The type of filter. Valid values include the following: \"Equal\"|\"NotEqual\"|\"BeginWith\"|\"LessThan\"|\"GreaterThan\"</p>"
"documentation":"<p>The type of filter.</p>"
}
},
"documentation":"<p>One or more filters. Use a filter to return a more specific list of results.</p>"
@ -9575,6 +9576,7 @@
"shape":"Comment",
"documentation":"<p>Information about the commands to run.</p>"
},
"CloudWatchOutputConfig":{"shape":"CloudWatchOutputConfig"},
"DocumentHash":{
"shape":"DocumentHash",
"documentation":"<p>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.</p>"
@ -9583,6 +9585,10 @@
"shape":"DocumentHashType",
"documentation":"<p>SHA-256 or SHA-1. SHA-1 hashes have been deprecated.</p>"
},
"DocumentVersion":{
"shape":"DocumentVersion",
"documentation":"<p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:</p> <p>--document-version \"\\$DEFAULT\"</p> <p>--document-version \"\\$LATEST\"</p> <p>--document-version \"3\"</p>"
},
"NotificationConfig":{
"shape":"NotificationConfig",
"documentation":"<p>Configurations for sending notifications about command status changes on a per-instance basis.</p>"
@ -10356,7 +10362,7 @@
"LimitType":{"shape":"String"},
"Message":{"shape":"String"}
},
"documentation":"<p>The request caused OpsItems to exceed one or more limits. For information about OpsItem limits, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits\">What are the resource limits for OpsCenter?</a>.</p>",
"documentation":"<p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits\">What are the resource limits for OpsCenter?</a>.</p>",
"exception":true
},
"OpsItemMaxResults":{
@ -11278,10 +11284,7 @@
},
"PatchRule":{
"type":"structure",
"required":[
"PatchFilterGroup",
"ApproveAfterDays"
],
"required":["PatchFilterGroup"],
"members":{
"PatchFilterGroup":{
"shape":"PatchFilterGroup",
@ -11296,6 +11299,11 @@
"documentation":"<p>The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of <code>7</code> means that patches are approved seven days after they are released. </p>",
"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>",
"box":true
},
"EnableNonSecurity":{
"shape":"Boolean",
"documentation":"<p>For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.</p>",
@ -11397,6 +11405,12 @@
},
"documentation":"<p>Information about the approval status of a patch.</p>"
},
"PatchStringDate":{
"type":"string",
"max":10,
"min":1,
"pattern":"^(\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$"
},
"PatchTitle":{"type":"string"},
"PatchUnreportedNotApplicableCount":{"type":"integer"},
"PatchVendor":{"type":"string"},
@ -11532,7 +11546,7 @@
"members":{
"Name":{
"shape":"PSParameterName",
"documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an AWS Region</p> </li> <li> <p>A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-/</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html\">Requirements and Constraints for Parameter Names</a> in the <i>AWS Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters, including the full length of the parameter ARN. For example, the following fully qualified parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>"
"documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an AWS Region</p> </li> <li> <p>A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-/</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html\">Requirements and Constraints for Parameter Names</a> in the <i>AWS Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>"
},
"Description":{
"shape":"ParameterDescription",
@ -12120,7 +12134,7 @@
},
"AwsOrganizationsSource":{
"shape":"ResourceDataSyncAwsOrganizationsSource",
"documentation":"<p>The field name in <code>SyncSource</code> for the <code>ResourceDataSyncAwsOrganizationsSource</code> type.</p>"
"documentation":"<p>Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations.</p>"
},
"SourceRegions":{
"shape":"ResourceDataSyncSourceRegionList",
@ -12197,7 +12211,7 @@
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.</p> <p>For information about resource limits in Systems Manager, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_ssm\">AWS Systems Manager Limits</a>.</p>",
"documentation":"<p>Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.</p> <p>For information about resource quotas in Systems Manager, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm\">Systems Manager Service Quotas</a> in the <i>AWS General Reference</i>.</p>",
"exception":true
},
"ResourceType":{
@ -12260,7 +12274,7 @@
},
"StreamUrl":{
"shape":"StreamUrl",
"documentation":"<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p> <p> <b>region</b> represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in the <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#ssm_region\">AWS Systems Manager table of regions and endpoints</a> in the <i>AWS General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>"
"documentation":"<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p> <p> <b>region</b> represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager Service Endpoints</a> in the <i>AWS General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>"
}
}
},
@ -12788,6 +12802,10 @@
"shape":"TargetLocations",
"documentation":"<p>A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html\">Executing Automations in Multiple AWS Regions and Accounts</a> in the <i>AWS Systems Manager User Guide</i>. </p>",
"box":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key name/value pairs:</p> <ul> <li> <p> <code>Key=environment,Value=test</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a> action.</p> </note>"
}
}
},
@ -12831,7 +12849,7 @@
},
"StreamUrl":{
"shape":"StreamUrl",
"documentation":"<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code> </p> <p> <b>region</b> represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in the <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#ssm_region\">AWS Systems Manager table of regions and endpoints</a> in the <i>AWS General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>"
"documentation":"<p>A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code> </p> <p> <b>region</b> represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href=\"http://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region\">Systems Manager Service Endpoints</a> in the <i>AWS General Reference</i>.</p> <p> <b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>"
}
}
},
@ -12892,7 +12910,7 @@
},
"StepStatus":{
"shape":"AutomationExecutionStatus",
"documentation":"<p>The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.</p>"
"documentation":"<p>The execution status for this step.</p>"
},
"ResponseCode":{
"shape":"String",

View file

@ -3083,6 +3083,7 @@
"VMWARE",
"HYPER-V",
"EC2",
"KVM",
"OTHER"
]
},

View file

@ -29,6 +29,22 @@
],
"documentation":"<p>Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. </p>"
},
"CreateVocabularyFilter":{
"name":"CreateVocabularyFilter",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateVocabularyFilterRequest"},
"output":{"shape":"CreateVocabularyFilterResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.</p>"
},
"DeleteTranscriptionJob":{
"name":"DeleteTranscriptionJob",
"http":{
@ -58,6 +74,21 @@
],
"documentation":"<p>Deletes a vocabulary from Amazon Transcribe. </p>"
},
"DeleteVocabularyFilter":{
"name":"DeleteVocabularyFilter",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteVocabularyFilterRequest"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"BadRequestException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Removes a vocabulary filter.</p>"
},
"GetTranscriptionJob":{
"name":"GetTranscriptionJob",
"http":{
@ -90,6 +121,22 @@
],
"documentation":"<p>Gets information about a vocabulary. </p>"
},
"GetVocabularyFilter":{
"name":"GetVocabularyFilter",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetVocabularyFilterRequest"},
"output":{"shape":"GetVocabularyFilterResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Returns information about a vocabulary filter.</p>"
},
"ListTranscriptionJobs":{
"name":"ListTranscriptionJobs",
"http":{
@ -120,6 +167,21 @@
],
"documentation":"<p>Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.</p>"
},
"ListVocabularyFilters":{
"name":"ListVocabularyFilters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVocabularyFiltersRequest"},
"output":{"shape":"ListVocabularyFiltersResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about vocabulary filters.</p>"
},
"StartTranscriptionJob":{
"name":"StartTranscriptionJob",
"http":{
@ -152,6 +214,22 @@
{"shape":"ConflictException"}
],
"documentation":"<p>Updates an existing vocabulary with new values. The <code>UpdateVocabulary</code> operation overwrites all of the existing information with the values that you provide in the request. </p>"
},
"UpdateVocabularyFilter":{
"name":"UpdateVocabularyFilter",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateVocabularyFilterRequest"},
"output":{"shape":"UpdateVocabularyFilterResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Updates a vocabulary filter with a new list of filtered words.</p>"
}
},
"shapes":{
@ -172,6 +250,48 @@
"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
},
"CreateVocabularyFilterRequest":{
"type":"structure",
"required":[
"VocabularyFilterName",
"LanguageCode"
],
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The vocabulary filter name. The name must be unique within the account that contains it.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.</p>"
},
"Words":{
"shape":"Words",
"documentation":"<p>The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets\">Character Sets for Custom Vocabularies</a>.</p> <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the <code>VocabularyFilterFileUri</code> parameter.</p>"
},
"VocabularyFilterFileUri":{
"shape":"Uri",
"documentation":"<p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets\">Character Sets for Custom Vocabularies</a>.</p> <p>The specified file must be less than 50 KB of UTF-8 characters.</p> <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code> parameter, you can't use the <code>Words</code> parameter.</p>"
}
}
},
"CreateVocabularyFilterResponse":{
"type":"structure",
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the words in the collection.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary filter was modified.</p>"
}
}
},
"CreateVocabularyRequest":{
"type":"structure",
"required":[
@ -222,6 +342,10 @@
}
}
},
"DataAccessRoleArn":{
"type":"string",
"pattern":"^arn:aws:iam::[0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1023}$"
},
"DateTime":{"type":"timestamp"},
"DeleteTranscriptionJobRequest":{
"type":"structure",
@ -233,6 +357,16 @@
}
}
},
"DeleteVocabularyFilterRequest":{
"type":"structure",
"required":["VocabularyFilterName"],
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter to remove.</p>"
}
}
},
"DeleteVocabularyRequest":{
"type":"structure",
"required":["VocabularyName"],
@ -263,6 +397,37 @@
}
}
},
"GetVocabularyFilterRequest":{
"type":"structure",
"required":["VocabularyFilterName"],
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter for which to return information.</p>"
}
}
},
"GetVocabularyFilterResponse":{
"type":"structure",
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the words in the vocabulary filter.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the contents of the vocabulary filter were updated.</p>"
},
"DownloadUri":{
"shape":"Uri",
"documentation":"<p>The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.</p>"
}
}
},
"GetVocabularyRequest":{
"type":"structure",
"required":["VocabularyName"],
@ -311,6 +476,20 @@
"exception":true,
"fault":true
},
"JobExecutionSettings":{
"type":"structure",
"members":{
"AllowDeferredExecution":{
"shape":"Boolean",
"documentation":"<p>Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the <code>AllowDeferredExecution</code> field is true, jobs are queued and will be executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a <code>LimitExceededException</code> exception.</p> <p>If you specify the <code>AllowDeferredExecution</code> field, you must specify the <code>DataAccessRoleArn</code> field.</p>"
},
"DataAccessRoleArn":{
"shape":"DataAccessRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe will assume this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.</p> <p>If you specify the <code>AllowDeferredExecution</code> field, you must specify the <code>DataAccessRoleArn</code> field.</p>"
}
},
"documentation":"<p>Provides information about when a transcription job should be executed.</p>"
},
"KMSKeyId":{
"type":"string",
"max":2048,
@ -437,6 +616,36 @@
}
}
},
"ListVocabularyFiltersRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request to <code>ListVocabularyFilters</code> was truncated, include the <code>NextToken</code> to fetch the next set of collections.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.</p>"
},
"NameContains":{
"shape":"VocabularyFilterName",
"documentation":"<p>Filters the response so that it only contains vocabulary filters whose name contains the specified string.</p>"
}
}
},
"ListVocabularyFiltersResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>ListVocabularyFilters</code> operation returns a page of collections at a time. The maximum size of the page is set by the <code>MaxResults</code> parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the <code>NextPage</code> token. Include the token in the next request to the <code>ListVocabularyFilters</code> operation to return in the next page of jobs.</p>"
},
"VocabularyFilters":{
"shape":"VocabularyFilters",
"documentation":"<p>The list of vocabulary filters. It will contain at most <code>MaxResults</code> number of filters. If there are more filters, call the <code>ListVocabularyFilters</code> operation again with the <code>NextToken</code> parameter in the request set to the value of the <code>NextToken</code> field in the response.</p>"
}
}
},
"MaxAlternatives":{
"type":"integer",
"max":10,
@ -537,6 +746,14 @@
"MaxAlternatives":{
"shape":"MaxAlternatives",
"documentation":"<p>The number of alternative transcriptions that the service should return. If you specify the <code>MaxAlternatives</code> field, you must set the <code>ShowAlternatives</code> field to true.</p>"
},
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.</p>"
},
"VocabularyFilterMethod":{
"shape":"VocabularyFilterMethod",
"documentation":"<p>Set to <code>mask</code> to remove filtered text from the transcript and replace it with three asterisks (\"***\") as placeholder text. Set to <code>remove</code> to remove filtered text from the transcript without using placeholder text.</p>"
}
},
"documentation":"<p>Provides optional settings for the <code>StartTranscriptionJob</code> operation.</p>"
@ -580,6 +797,10 @@
"Settings":{
"shape":"Settings",
"documentation":"<p>A <code>Settings</code> object that provides optional settings for a transcription job.</p>"
},
"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>"
}
}
},
@ -634,6 +855,10 @@
"shape":"Transcript",
"documentation":"<p>An object that describes the output of the transcription job.</p>"
},
"StartTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows with the job was started processing.</p>"
},
"CreationTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was created.</p>"
@ -649,6 +874,10 @@
"Settings":{
"shape":"Settings",
"documentation":"<p>Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.</p>"
},
"JobExecutionSettings":{
"shape":"JobExecutionSettings",
"documentation":"<p>Provides information about how a transcription job is executed.</p>"
}
},
"documentation":"<p>Describes an asynchronous transcription job that was created with the <code>StartTranscriptionJob</code> operation. </p>"
@ -662,6 +891,7 @@
"TranscriptionJobStatus":{
"type":"string",
"enum":[
"QUEUED",
"IN_PROGRESS",
"FAILED",
"COMPLETED"
@ -682,6 +912,10 @@
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was created.</p>"
},
"StartTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job started processing.</p>"
},
"CompletionTime":{
"shape":"DateTime",
"documentation":"<p>A timestamp that shows when the job was completed.</p>"
@ -705,6 +939,41 @@
},
"documentation":"<p>Provides a summary of information about a transcription job.</p>"
},
"UpdateVocabularyFilterRequest":{
"type":"structure",
"required":["VocabularyFilterName"],
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter to update.</p>"
},
"Words":{
"shape":"Words",
"documentation":"<p>The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets\">Character Sets for Custom Vocabularies</a>.</p> <p>If you provide a list of words in the <code>Words</code> parameter, you can't use the <code>VocabularyFilterFileUri</code> parameter.</p>"
},
"VocabularyFilterFileUri":{
"shape":"Uri",
"documentation":"<p>The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html#charsets\">Character Sets for Custom Vocabularies</a>.</p> <p>The specified file must be less than 50 KB of UTF-8 characters.</p> <p>If you provide the location of a list of words in the <code>VocabularyFilterFileUri</code> parameter, you can't use the <code>Words</code> parameter.</p>"
}
}
},
"UpdateVocabularyFilterResponse":{
"type":"structure",
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the updated vocabulary filter.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the words in the vocabulary filter.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary filter was updated.</p>"
}
}
},
"UpdateVocabularyRequest":{
"type":"structure",
"required":[
@ -761,6 +1030,41 @@
"type":"list",
"member":{"shape":"VocabularyInfo"}
},
"VocabularyFilterInfo":{
"type":"structure",
"members":{
"VocabularyFilterName":{
"shape":"VocabularyFilterName",
"documentation":"<p>The name of the vocabulary filter. The name must be unique in the account that holds the filter.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the words in the vocabulary filter.</p>"
},
"LastModifiedTime":{
"shape":"DateTime",
"documentation":"<p>The date and time that the vocabulary was last updated.</p>"
}
},
"documentation":"<p>Provides information about a vocabulary filter.</p>"
},
"VocabularyFilterMethod":{
"type":"string",
"enum":[
"remove",
"mask"
]
},
"VocabularyFilterName":{
"type":"string",
"max":200,
"min":1,
"pattern":"^[0-9a-zA-Z._-]+"
},
"VocabularyFilters":{
"type":"list",
"member":{"shape":"VocabularyFilterInfo"}
},
"VocabularyInfo":{
"type":"structure",
"members":{
@ -796,6 +1100,16 @@
"READY",
"FAILED"
]
},
"Word":{
"type":"string",
"max":256,
"min":1
},
"Words":{
"type":"list",
"member":{"shape":"Word"},
"min":1
}
},
"documentation":"<p>Operations and objects for transcribing speech to text.</p>"

View file

@ -107,7 +107,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of the server's properties.</p>"
"documentation":"<p>Describes the server that you specify by passing the <code>ServerId</code> parameter.</p> <p>The response contains a description of the server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>"
},
"DescribeUser":{
"name":"DescribeUser",
@ -280,6 +280,7 @@
"output":{"shape":"UpdateServerResponse"},
"errors":[
{"shape":"ServiceUnavailableException"},
{"shape":"ConflictException"},
{"shape":"InternalServiceError"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
@ -307,22 +308,36 @@
}
},
"shapes":{
"AddressAllocationId":{"type":"string"},
"AddressAllocationIds":{
"type":"list",
"member":{"shape":"AddressAllocationId"}
},
"Arn":{
"type":"string",
"max":1600,
"min":20,
"pattern":"arn:.*"
},
"ConflictException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"Message"}
},
"documentation":"<p>This exception is thrown when the <code>UpdatServer</code> is called for a server that has VPC as the endpoint type and the server's <code>VpcEndpointID</code> is not in the available state.</p>",
"exception":true
},
"CreateServerRequest":{
"type":"structure",
"members":{
"EndpointDetails":{
"shape":"EndpointDetails",
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the <code>EndpointType</code> parameter.</p>"
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the <code>UpdateServer</code> API and attach an Elastic IP to your server's endpoint. </p>"
},
"EndpointType":{
"shape":"EndpointType",
"documentation":"<p>The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
"documentation":"<p>The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.</p>"
},
"HostKey":{
"shape":"HostKey",
@ -374,7 +389,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
"documentation":"<p>Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"<code>Entry</code>\" and \"<code>Target</code>\" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value. </p>"
"documentation":"<p>Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"<code>Entry</code>\" and \"<code>Target</code>\" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value. </p> <note> <p>If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a / for it to be considered a folder. </p> </note>"
},
"Policy":{
"shape":"Policy",
@ -620,17 +635,30 @@
"EndpointDetails":{
"type":"structure",
"members":{
"AddressAllocationIds":{
"shape":"AddressAllocationIds",
"documentation":"<p>A list of address allocation IDs that are required to attach an Elastic IP address to your SFTP server's endpoint. This is only valid in the <code>UpdateServer</code> API.</p> <note> <p>This property can only be use when <code>EndpointType</code> is set to <code>VPC</code>.</p> </note>"
},
"SubnetIds":{
"shape":"SubnetIds",
"documentation":"<p>A list of subnet IDs that are required to host your SFTP server endpoint in your VPC.</p>"
},
"VpcEndpointId":{
"shape":"VpcEndpointId",
"documentation":"<p>The ID of the VPC endpoint.</p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The VPC ID of the virtual private cloud in which the SFTP server's endpoint will be hosted.</p>"
}
},
"documentation":"<p>The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.</p>"
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC. To control incoming internet traffic, invoke the <code>UpdateServer</code> API and attach an Elastic IP to your server's endpoint. </p>"
},
"EndpointType":{
"type":"string",
"enum":[
"PUBLIC",
"VPC",
"VPC_ENDPOINT"
]
},
@ -1106,6 +1134,11 @@
}
}
},
"SubnetId":{"type":"string"},
"SubnetIds":{
"type":"list",
"member":{"shape":"SubnetId"}
},
"Tag":{
"type":"structure",
"required":[
@ -1238,7 +1271,7 @@
"members":{
"EndpointDetails":{
"shape":"EndpointDetails",
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint. </p>"
},
"EndpointType":{
"shape":"EndpointType",
@ -1289,7 +1322,7 @@
},
"HomeDirectoryMappings":{
"shape":"HomeDirectoryMappings",
"documentation":"<p>Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"<code>Entry</code>\" and \"<code>Target</code>\" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value. </p> <p> </p>"
"documentation":"<p>Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"<code>Entry</code>\" and \"<code>Target</code>\" pair, where <code>Entry</code> shows how the path is made visible and <code>Target</code> is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in <code>Target</code>. The following is an example.</p> <p> <code>'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'</code> </p> <p>In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory parameter value. </p> <note> <p>If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. Make sure that the end of the key name ends in a / for it to be considered a folder. </p> </note>"
},
"Policy":{
"shape":"Policy",
@ -1348,7 +1381,8 @@
"max":22,
"min":22,
"pattern":"^vpce-[0-9a-f]{17}$"
}
},
"VpcId":{"type":"string"}
},
"documentation":"<p>AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up. </p>"
}

View file

@ -27,6 +27,21 @@
],
"documentation":"<p>A synchronous action that deletes a custom terminology.</p>"
},
"DescribeTextTranslationJob":{
"name":"DescribeTextTranslationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTextTranslationJobRequest"},
"output":{"shape":"DescribeTextTranslationJobResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.</p>"
},
"GetTerminology":{
"name":"GetTerminology",
"http":{
@ -74,6 +89,54 @@
],
"documentation":"<p>Provides a list of custom terminologies associated with your account.</p>"
},
"ListTextTranslationJobs":{
"name":"ListTextTranslationJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTextTranslationJobsRequest"},
"output":{"shape":"ListTextTranslationJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of the batch translation jobs that you have submitted.</p>"
},
"StartTextTranslationJob":{
"name":"StartTextTranslationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartTextTranslationJobRequest"},
"output":{"shape":"StartTextTranslationJobResponse"},
"errors":[
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedLanguagePairException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see <a>async</a>.</p> <p>Batch translation jobs can be described with the <a>DescribeTextTranslationJob</a> operation, listed with the <a>ListTextTranslationJobs</a> operation, and stopped with the <a>StopTextTranslationJob</a> operation.</p> <note> <p>Amazon Translate does not support batch translation of multiple source languages at once.</p> </note>"
},
"StopTextTranslationJob":{
"name":"StopTextTranslationJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopTextTranslationJobRequest"},
"output":{"shape":"StopTextTranslationJobResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops an asynchronous batch translation job that is in progress.</p> <p>If the job's state is <code>IN_PROGRESS</code>, the job will be marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state. Otherwise, the job is put into the <code>STOPPED</code> state.</p> <p>Asynchronous batch translation jobs are started with the <a>StartTextTranslationJob</a> operation. You can use the <a>DescribeTextTranslationJob</a> or <a>ListTextTranslationJobs</a> operations to get a batch translation job's <code>JobId</code>.</p>"
},
"TranslateText":{
"name":"TranslateText",
"http":{
@ -92,7 +155,7 @@
{"shape":"InternalServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see <a href=\"http://docs.aws.amazon.com/translate/latest/dg/pairs.html\">Supported Language Pairs</a>.</p> <ul> <li> <p>Arabic (ar)</p> </li> <li> <p>Chinese (Simplified) (zh)</p> </li> <li> <p>Chinese (Traditional) (zh-TW)</p> </li> <li> <p>Czech (cs)</p> </li> <li> <p>Danish (da)</p> </li> <li> <p>Dutch (nl)</p> </li> <li> <p>English (en)</p> </li> <li> <p>Finnish (fi)</p> </li> <li> <p>French (fr)</p> </li> <li> <p>German (de)</p> </li> <li> <p>Hebrew (he)</p> </li> <li> <p>Indonesian (id)</p> </li> <li> <p>Italian (it)</p> </li> <li> <p>Japanese (ja)</p> </li> <li> <p>Korean (ko)</p> </li> <li> <p>Polish (pl)</p> </li> <li> <p>Portuguese (pt)</p> </li> <li> <p>Russian (ru)</p> </li> <li> <p>Spanish (es)</p> </li> <li> <p>Swedish (sv)</p> </li> <li> <p>Turkish (tr)</p> </li> </ul> <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call Amazon Comprehend to determine the source language.</p>"
"documentation":"<p>Translates input text from the source language to the target language. For a list of available languages and language codes, see <a>what-is-languages</a>.</p>"
}
},
"shapes":{
@ -120,6 +183,17 @@
"min":1,
"pattern":"[\\P{M}\\p{M}]{1,5000}"
},
"ClientTokenString":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9-]+$"
},
"ContentType":{
"type":"string",
"max":256,
"pattern":"^[-\\w.]+\\/[-\\w.+]+$"
},
"DeleteTerminologyRequest":{
"type":"structure",
"required":["Name"],
@ -130,6 +204,25 @@
}
}
},
"DescribeTextTranslationJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Translate generated for the job. The <a>StartTextTranslationJob</a> operation returns this identifier in its response.</p>"
}
}
},
"DescribeTextTranslationJobResponse":{
"type":"structure",
"members":{
"TextTranslationJobProperties":{
"shape":"TextTranslationJobProperties",
"documentation":"<p>An object that contains the properties associated with an asynchronous batch translation job.</p>"
}
}
},
"Description":{
"type":"string",
"max":256,
@ -169,7 +262,7 @@
"type":"string",
"max":400,
"min":1,
"pattern":"(arn:aws((-us-gov)|(-cn))?:kms:)?([a-z]{2}-[a-z]+-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))"
"pattern":"(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))"
},
"EncryptionKeyType":{
"type":"string",
@ -205,6 +298,12 @@
}
}
},
"IamRoleArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
},
"ImportTerminologyRequest":{
"type":"structure",
"required":[
@ -244,16 +343,42 @@
}
}
},
"InputDataConfig":{
"type":"structure",
"required":[
"S3Uri",
"ContentType"
],
"members":{
"S3Uri":{
"shape":"S3Uri",
"documentation":"<p>The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.</p>"
},
"ContentType":{
"shape":"ContentType",
"documentation":"<p>The multipurpose internet mail extension (MIME) type of the input files. Valid values are <code>text/plain</code> for plaintext files and <code>text/html</code> for HTML files.</p>"
}
},
"documentation":"<p>The input configuration properties for requesting a batch translation job.</p>"
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p> An internal server error occurred. Retry your request.</p>",
"documentation":"<p>An internal server error occurred. Retry your request.</p>",
"exception":true,
"fault":true
},
"InvalidFilterException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The filter specified for the operation is invalid. Specify a different filter.</p>",
"exception":true
},
"InvalidParameterValueException":{
"type":"structure",
"members":{
@ -270,6 +395,48 @@
"documentation":"<p> The request that you made is invalid. Check your request to determine why it's invalid and then retry the request. </p>",
"exception":true
},
"JobDetails":{
"type":"structure",
"members":{
"TranslatedDocumentsCount":{
"shape":"Integer",
"documentation":"<p>The number of documents successfully processed during a translation job.</p>"
},
"DocumentsWithErrorsCount":{
"shape":"Integer",
"documentation":"<p>The number of documents that could not be processed during a translation job.</p>"
},
"InputDocumentsCount":{
"shape":"Integer",
"documentation":"<p>The number of documents used as input in a translation job.</p>"
}
},
"documentation":"<p>The number of documents successfully and unsuccessfully processed during a translation job.</p>"
},
"JobId":{
"type":"string",
"max":32,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
},
"JobName":{
"type":"string",
"max":256,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
},
"JobStatus":{
"type":"string",
"enum":[
"SUBMITTED",
"IN_PROGRESS",
"COMPLETED",
"COMPLETED_WITH_ERROR",
"FAILED",
"STOP_REQUESTED",
"STOPPED"
]
},
"LanguageCodeString":{
"type":"string",
"max":5,
@ -309,7 +476,37 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p> If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies. </p>"
"documentation":"<p> If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.</p>"
}
}
},
"ListTextTranslationJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"TextTranslationJobFilter",
"documentation":"<p>The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to request the next page of results.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default value is 100.</p>"
}
}
},
"ListTextTranslationJobsResponse":{
"type":"structure",
"members":{
"TextTranslationJobPropertiesList":{
"shape":"TextTranslationJobPropertiesList",
"documentation":"<p>A list containing the properties of each job that is returned.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retreive the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
@ -327,6 +524,17 @@
"max":8192,
"pattern":"\\p{ASCII}{0,8192}"
},
"OutputDataConfig":{
"type":"structure",
"required":["S3Uri"],
"members":{
"S3Uri":{
"shape":"S3Uri",
"documentation":"<p>The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.</p>"
}
},
"documentation":"<p>The output configuration properties for a batch translation job.</p>"
},
"ResourceName":{
"type":"string",
"max":256,
@ -342,22 +550,116 @@
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .</p>",
"documentation":"<p>The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.</p>",
"exception":true
},
"S3Uri":{
"type":"string",
"max":1024,
"pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.</p>",
"exception":true
"exception":true,
"fault":true
},
"StartTextTranslationJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"SourceLanguageCode",
"TargetLanguageCodes",
"ClientToken"
],
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>The name of the batch translation job to be performed.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and S3 location of the input documents for the translation job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies the S3 folder to which your job output will be saved. </p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see <a>identity-and-access-management</a>.</p>"
},
"SourceLanguageCode":{
"shape":"LanguageCodeString",
"documentation":"<p>The language code of the input language. For a list of language codes, see <a>what-is-languages</a>.</p> <p>Amazon Translate does not automatically detect a source language during batch translation jobs.</p>"
},
"TargetLanguageCodes":{
"shape":"TargetLanguageCodeStringList",
"documentation":"<p>The language code of the output language.</p>"
},
"TerminologyNames":{
"shape":"ResourceNameList",
"documentation":"<p>The name of the terminology to use in the batch translation job. For a list of available terminologies, use the <a>ListTerminologies</a> operation.</p>"
},
"ClientToken":{
"shape":"ClientTokenString",
"documentation":"<p>The client token of the EC2 instance calling the request. This token is auto-generated when using the Amazon Translate SDK. Otherwise, use the <a href=\"docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\">DescribeInstances</a> EC2 operation to retreive an instance's client token. For more information, see <a href=\"docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html#client-tokens\">Client Tokens</a> in the EC2 User Guide.</p>",
"idempotencyToken":true
}
}
},
"StartTextTranslationJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this ID with the <a>DescribeTextTranslationJob</a> operation.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the job. Possible values include:</p> <ul> <li> <p> <code>SUBMITTED</code> - The job has been received and is queued for processing.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Amazon Translate is processing the job.</p> </li> <li> <p> <code>COMPLETED</code> - The job was successfully completed and the output is available.</p> </li> <li> <p> <code>COMPLETED_WITH_ERRORS</code> - The job was completed with errors. The errors can be analyzed in the job's output.</p> </li> <li> <p> <code>FAILED</code> - The job did not complete. To get details, use the <a>DescribeTextTranslationJob</a> operation.</p> </li> <li> <p> <code>STOP_REQUESTED</code> - The user who started the job has requested that it be stopped.</p> </li> <li> <p> <code>STOPPED</code> - The job has been stopped.</p> </li> </ul>"
}
}
},
"StopTextTranslationJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The job ID of the job to be stopped.</p>"
}
}
},
"StopTextTranslationJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The job ID of the stopped batch translation job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the designated job. Upon successful completion, the job's status will be <code>STOPPED</code>.</p>"
}
}
},
"String":{
"type":"string",
"max":10000,
"pattern":"[\\P{M}\\p{M}]{0,10000}"
},
"TargetLanguageCodeStringList":{
"type":"list",
"member":{"shape":"LanguageCodeString"},
"max":1,
"min":1
},
"Term":{
"type":"structure",
"members":{
@ -378,7 +680,7 @@
},
"TerminologyArn":{
"type":"string",
"pattern":"^arn:aws((-us-gov)|(-cn))?:translate:[a-zA-Z0-9-]+:[0-9]{12}:terminology/.+?/.+?$"
"pattern":"^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:translate:[a-zA-Z0-9-]+:[0-9]{12}:terminology/.+?/.+?$"
},
"TerminologyData":{
"type":"structure",
@ -389,7 +691,7 @@
"members":{
"File":{
"shape":"TerminologyFile",
"documentation":"<p>The file containing the custom terminology data.</p>"
"documentation":"<p>The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.</p>"
},
"Format":{
"shape":"TerminologyDataFormat",
@ -486,6 +788,90 @@
"documentation":"<p> The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request. </p>",
"exception":true
},
"TextTranslationJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters the list of jobs by name.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based by job status.</p>"
},
"SubmittedBeforeTime":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmittedAfterTime":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of translation jobs. For more information, see <a>ListTextTranslationJobs</a>.</p>"
},
"TextTranslationJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The ID of the translation job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The user-defined name of the translation job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The status of the translation job.</p>"
},
"JobDetails":{
"shape":"JobDetails",
"documentation":"<p>The number of documents successfully and unsuccessfully processed during the translation job.</p>"
},
"SourceLanguageCode":{
"shape":"LanguageCodeString",
"documentation":"<p>The language code of the language of the source text. The language must be a language supported by Amazon Translate.</p>"
},
"TargetLanguageCodes":{
"shape":"TargetLanguageCodeStringList",
"documentation":"<p>The language code of the language of the target text. The language must be a language supported by Amazon Translate.</p>"
},
"TerminologyNames":{
"shape":"ResourceNameList",
"documentation":"<p>A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per <a>StartTextTranslationJob</a> request at this time.</p>"
},
"Message":{
"shape":"UnboundedLengthString",
"documentation":"<p>An explanation of any errors that may have occured during the translation job.</p>"
},
"SubmittedTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the translation job was submitted.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time at which the translation job ended.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input configuration properties that were specified when the job was requested.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output configuration properties that were specified when the job was requested.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.</p>"
}
},
"documentation":"<p>Provides information about a translation job.</p>"
},
"TextTranslationJobPropertiesList":{
"type":"list",
"member":{"shape":"TextTranslationJobProperties"}
},
"Timestamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
@ -509,11 +895,11 @@
},
"TerminologyNames":{
"shape":"ResourceNameList",
"documentation":"<p>The TerminologyNames list that is taken as input to the TranslateText request. This has a minimum length of 0 and a maximum length of 1.</p>"
"documentation":"<p>The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a <code>TranslateText</code> request. Terminology lists can contain a maximum of 256 terms.</p>"
},
"SourceLanguageCode":{
"shape":"LanguageCodeString",
"documentation":"<p>The language code for the language of the source text. The language must be a language supported by Amazon Translate. </p> <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call Amazon Comprehend to determine the source language.</p>"
"documentation":"<p>The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see <a>what-is-languages</a>.</p> <p>To have Amazon Translate determine the source language of your text, you can specify <code>auto</code> in the <code>SourceLanguageCode</code> field. If you specify <code>auto</code>, Amazon Translate will call <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html\">Amazon Comprehend</a> to determine the source language.</p>"
},
"TargetLanguageCode":{
"shape":"LanguageCodeString",
@ -531,11 +917,11 @@
"members":{
"TranslatedText":{
"shape":"String",
"documentation":"<p>The the translated text. The maximum length of this text is 5kb.</p>"
"documentation":"<p>The translated text.</p>"
},
"SourceLanguageCode":{
"shape":"LanguageCodeString",
"documentation":"<p>The language code for the language of the source text. </p>"
"documentation":"<p>The language code for the language of the source text.</p>"
},
"TargetLanguageCode":{
"shape":"LanguageCodeString",
@ -547,6 +933,7 @@
}
}
},
"UnboundedLengthString":{"type":"string"},
"UnsupportedLanguagePairException":{
"type":"structure",
"members":{

View file

@ -67,7 +67,8 @@
{"shape":"MailDomainNotFoundException"},
{"shape":"MailDomainStateException"},
{"shape":"OrganizationNotFoundException"},
{"shape":"OrganizationStateException"}
{"shape":"OrganizationStateException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds an alias to the set of a given member (user or group) of Amazon WorkMail.</p>",
"idempotent":true
@ -485,6 +486,19 @@
"documentation":"<p>Returns summaries of the organization's resources.</p>",
"idempotent":true
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the tags applied to an Amazon WorkMail organization resource.</p>"
},
"ListUsers":{
"name":"ListUsers",
"http":{
@ -565,6 +579,34 @@
"documentation":"<p>Allows the administrator to reset the password for a user.</p>",
"idempotent":true
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"TooManyTagsException"},
{"shape":"OrganizationStateException"}
],
"documentation":"<p>Applies the specified tags to the specified Amazon WorkMail organization resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Untags the specified tags from the specified Amazon WorkMail organization resource.</p>"
},
"UpdateMailboxQuota":{
"name":"UpdateMailboxQuota",
"http":{
@ -637,6 +679,11 @@
"type":"list",
"member":{"shape":"EmailAddress"}
},
"AmazonResourceName":{
"type":"string",
"max":1011,
"min":1
},
"AssociateDelegateToResourceRequest":{
"type":"structure",
"required":[
@ -1080,6 +1127,10 @@
"ErrorMessage":{
"shape":"String",
"documentation":"<p>(Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.</p>"
},
"ARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the organization.</p>"
}
}
},
@ -1125,7 +1176,7 @@
},
"State":{
"shape":"EntityState",
"documentation":"<p>The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).</p>"
"documentation":"<p>The state of the resource: enabled (registered to Amazon WorkMail), disabled (deregistered or never registered to WorkMail), or deleted.</p>"
},
"EnabledDate":{
"shape":"Timestamp",
@ -1401,6 +1452,14 @@
"documentation":"<p>The supplied password doesn't match the minimum security constraints, such as length or use of special characters.</p>",
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The request exceeds the limit of the resource.</p>",
"exception":true
},
"ListAliasesRequest":{
"type":"structure",
"required":[
@ -1641,6 +1700,25 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The resource ARN.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key-value pairs.</p>"
}
}
},
"ListUsersRequest":{
"type":"structure",
"required":["OrganizationId"],
@ -1996,6 +2074,14 @@
"min":1,
"pattern":"[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The resource cannot be found.</p>",
"exception":true
},
"ResourceType":{
"type":"string",
"enum":[
@ -2011,7 +2097,77 @@
"type":"string",
"max":256
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>The key of the tag.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value of the tag.</p>"
}
},
"documentation":"<p>Describes a tag applied to a resource.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The resource ARN.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tag key-value pairs.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"Timestamp":{"type":"timestamp"},
"TooManyTagsException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The resource can have up to 50 user-applied tags.</p>",
"exception":true
},
"UnsupportedOperationException":{
"type":"structure",
"members":{
@ -2020,6 +2176,28 @@
"documentation":"<p>You can't perform a write operation against a read-only directory.</p>",
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"AmazonResourceName",
"documentation":"<p>The resource ARN.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateMailboxQuotaRequest":{
"type":"structure",
"required":[

View file

@ -371,6 +371,24 @@
],
"documentation":"<p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). </p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>"
},
"MigrateWorkspace":{
"name":"MigrateWorkspace",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"MigrateWorkspaceRequest"},
"output":{"shape":"MigrateWorkspaceResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"OperationNotSupportedException"},
{"shape":"OperationInProgressException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.</p> <p>The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original <code>D:\\Users\\%USERNAME%</code> user profile folder is renamed to <code>D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new <code>D:\\Users\\%USERNAME%\\</code> folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.</p> <p>For available migration scenarios, details about what happens during migration, and best practices, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html\">Migrate a WorkSpace</a>.</p>"
},
"ModifyAccount":{
"name":"ModifyAccount",
"http":{
@ -430,7 +448,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Specifies which devices and operating systems users can use to access their Workspaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access\"> Control Device Access</a>.</p>"
"documentation":"<p>Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access\"> Control Device Access</a>.</p>"
},
"ModifyWorkspaceCreationProperties":{
"name":"ModifyWorkspaceCreationProperties",
@ -499,7 +517,7 @@
},
"input":{"shape":"RebuildWorkspacesRequest"},
"output":{"shape":"RebuildWorkspacesResult"},
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, or <code>STOPPED</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
},
"RegisterWorkspaceDirectory":{
"name":"RegisterWorkspaceDirectory",
@ -534,7 +552,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>"
"documentation":"<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, or <code>STOPPED</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>"
},
"RevokeIpRules":{
"name":"RevokeIpRules",
@ -857,7 +875,7 @@
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>"
"documentation":"<p>The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to add new tags to a set of existing tags, you must submit all of the existing tags along with the new ones.</p>"
}
}
},
@ -1552,6 +1570,36 @@
"max":5,
"min":1
},
"MigrateWorkspaceRequest":{
"type":"structure",
"required":[
"SourceWorkspaceId",
"BundleId"
],
"members":{
"SourceWorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace to migrate from.</p>"
},
"BundleId":{
"shape":"BundleId",
"documentation":"<p>The identifier of the target bundle type to migrate the WorkSpace to.</p>"
}
}
},
"MigrateWorkspaceResult":{
"type":"structure",
"members":{
"SourceWorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The original identifier of the WorkSpace that is being migrated.</p>"
},
"TargetWorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.</p>"
}
}
},
"ModificationResourceEnum":{
"type":"string",
"enum":[
@ -2342,7 +2390,7 @@
},
"VolumeEncryptionKey":{
"shape":"VolumeEncryptionKey",
"documentation":"<p>The KMS key used to encrypt data stored on your WorkSpace.</p>"
"documentation":"<p>The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.</p>"
},
"UserVolumeEncryptionEnabled":{
"shape":"BooleanObject",
@ -2548,7 +2596,7 @@
},
"WorkspaceAccessProperties":{
"shape":"WorkspaceAccessProperties",
"documentation":"<p>The devices and operating systems that users can use to access Workspaces.</p>"
"documentation":"<p>The devices and operating systems that users can use to access WorkSpaces.</p>"
},
"Tenancy":{
"shape":"Tenancy",
@ -2729,7 +2777,7 @@
},
"VolumeEncryptionKey":{
"shape":"VolumeEncryptionKey",
"documentation":"<p>The KMS key used to encrypt data stored on your WorkSpace.</p>"
"documentation":"<p>The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.</p>"
},
"UserVolumeEncryptionEnabled":{
"shape":"BooleanObject",

View file

@ -177,7 +177,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.</p>"
"documentation":"<p>Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the <a href=\"https://docs.aws.amazon.com/xray/index.html\">AWS X-Ray SDK</a>. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.</p>"
},
"GetTimeSeriesServiceStatistics":{
"name":"GetTimeSeriesServiceStatistics",
@ -219,7 +219,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to <code>BatchGetTraces</code>.</p> <p>A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>:</p> <p> <code>service(\"api.example.com\")</code> </p> <p>This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>:</p> <p> <code>annotation.account = \"12345\"</code> </p> <p>For a full list of indexed fields and keywords that you can use in filter expressions, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html\">Using Filter Expressions</a> in the <i>AWS X-Ray Developer Guide</i>.</p>"
"documentation":"<p>Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to <code>BatchGetTraces</code>.</p> <p>A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through <code>api.example.com</code>:</p> <p> <code>service(\"api.example.com\")</code> </p> <p>This filter expression finds traces that have an annotation named <code>account</code> with the value <code>12345</code>:</p> <p> <code>annotation.account = \"12345\"</code> </p> <p>For a full list of indexed fields and keywords that you can use in filter expressions, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html\">Using Filter Expressions</a> in the <i>AWS X-Ray Developer Guide</i>.</p>"
},
"PutEncryptionConfig":{
"name":"PutEncryptionConfig",
@ -261,7 +261,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ThrottledException"}
],
"documentation":"<p>Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.</p> <p>Segments must include the following fields. For the full segment document schema, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html\">AWS X-Ray Segment Documents</a> in the <i>AWS X-Ray Developer Guide</i>.</p> <p class=\"title\"> <b>Required Segment Document Fields</b> </p> <ul> <li> <p> <code>name</code> - The name of the service that handled the request.</p> </li> <li> <p> <code>id</code> - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.</p> </li> <li> <p> <code>trace_id</code> - A unique identifier that connects all segments and subsegments originating from a single client request.</p> </li> <li> <p> <code>start_time</code> - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, <code>1480615200.010</code> or <code>1.480615200010E9</code>.</p> </li> <li> <p> <code>end_time</code> - Time the segment or subsegment was closed. For example, <code>1480615200.090</code> or <code>1.480615200090E9</code>. Specify either an <code>end_time</code> or <code>in_progress</code>.</p> </li> <li> <p> <code>in_progress</code> - Set to <code>true</code> instead of specifying an <code>end_time</code> to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.</p> </li> </ul> <p>A <code>trace_id</code> consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:</p> <p class=\"title\"> <b>Trace ID Format</b> </p> <ul> <li> <p>The version number, i.e. <code>1</code>.</p> </li> <li> <p>The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is <code>1480615200</code> seconds, or <code>58406520</code> in hexadecimal.</p> </li> <li> <p>A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.</p> </li> </ul>"
"documentation":"<p>Uploads segment documents to AWS X-Ray. The <a href=\"https://docs.aws.amazon.com/xray/index.html\">X-Ray SDK</a> generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.</p> <p>Segments must include the following fields. For the full segment document schema, see <a href=\"https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html\">AWS X-Ray Segment Documents</a> in the <i>AWS X-Ray Developer Guide</i>.</p> <p class=\"title\"> <b>Required Segment Document Fields</b> </p> <ul> <li> <p> <code>name</code> - The name of the service that handled the request.</p> </li> <li> <p> <code>id</code> - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.</p> </li> <li> <p> <code>trace_id</code> - A unique identifier that connects all segments and subsegments originating from a single client request.</p> </li> <li> <p> <code>start_time</code> - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, <code>1480615200.010</code> or <code>1.480615200010E9</code>.</p> </li> <li> <p> <code>end_time</code> - Time the segment or subsegment was closed. For example, <code>1480615200.090</code> or <code>1.480615200090E9</code>. Specify either an <code>end_time</code> or <code>in_progress</code>.</p> </li> <li> <p> <code>in_progress</code> - Set to <code>true</code> instead of specifying an <code>end_time</code> to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.</p> </li> </ul> <p>A <code>trace_id</code> consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:</p> <p class=\"title\"> <b>Trace ID Format</b> </p> <ul> <li> <p>The version number, i.e. <code>1</code>.</p> </li> <li> <p>The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is <code>1480615200</code> seconds, or <code>58406520</code> in hexadecimal.</p> </li> <li> <p>A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.</p> </li> </ul>"
},
"UpdateGroup":{
"name":"UpdateGroup",
@ -409,7 +409,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -426,7 +426,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -854,7 +854,7 @@
"members":{
"NextToken":{
"shape":"GetGroupsNextToken",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -867,7 +867,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -876,7 +876,7 @@
"members":{
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -889,7 +889,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -898,7 +898,7 @@
"members":{
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -911,7 +911,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -967,7 +967,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -992,7 +992,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -1029,7 +1029,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -1046,7 +1046,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -1060,7 +1060,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -1073,7 +1073,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token. Not used.</p>"
"documentation":"<p>Pagination token.</p>"
}
}
},
@ -1119,7 +1119,7 @@
"members":{
"TraceSummaries":{
"shape":"TraceSummaryList",
"documentation":"<p>Trace IDs and metadata for traces that were found in the specified time frame.</p>"
"documentation":"<p>Trace IDs and annotations for traces that were found in the specified time frame.</p>"
},
"ApproximateTime":{
"shape":"Timestamp",
@ -1275,7 +1275,7 @@
"members":{
"KeyId":{
"shape":"EncryptionKeyId",
"documentation":"<p>An AWS KMS customer master key (CMK) in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>"
"documentation":"<p>An AWS KMS customer master key (CMK) in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. AWS X-Ray does not support asymmetric CMKs.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>"
},
"Type":{
"shape":"EncryptionType",
@ -2021,11 +2021,11 @@
},
"HasFault":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents has a 500 series error.</p>"
"documentation":"<p>The root segment document has a 500 series error.</p>"
},
"HasError":{
"shape":"NullableBoolean",
"documentation":"<p>One or more of the segment documents has a 400 series error.</p>"
"documentation":"<p>The root segment document has a 400 series error.</p>"
},
"HasThrottle":{
"shape":"NullableBoolean",

View file

@ -484,6 +484,15 @@ class InvalidMaxRetryAttemptsError(InvalidRetryConfigurationError):
)
class InvalidS3UsEast1RegionalEndpointConfigError(BotoCoreError):
"""Error for invalid s3 us-east-1 regional endpoints configuration"""
fmt = (
'S3 us-east-1 regional endpoint option '
'{s3_us_east_1_regional_endpoint_config} is '
'invaild. Valid options are: legacy and regional'
)
class InvalidSTSRegionalEndpointsConfigError(BotoCoreError):
"""Error when invalid sts regional endpoints configuration is specified"""
fmt = (

View file

@ -782,7 +782,7 @@ class BaseRestParser(ResponseParser):
metadata['RequestId'] = headers['x-amzn-requestid']
elif 'x-amz-request-id' in headers:
metadata['RequestId'] = headers['x-amz-request-id']
# HostId is what it's called whenver this value is returned
# HostId is what it's called whenever this value is returned
# in an XML response body, so to be consistent, we'll always
# call is HostId.
metadata['HostId'] = headers.get('x-amz-id-2', '')

View file

@ -22,7 +22,6 @@ import os
import platform
import socket
import warnings
import collections
from botocore import __version__
from botocore import UNSIGNED
@ -49,6 +48,7 @@ from botocore import waiter
from botocore import retryhandler, translate
from botocore import utils
from botocore.utils import EVENT_ALIASES
from botocore.compat import MutableMapping
logger = logging.getLogger(__name__)
@ -941,7 +941,7 @@ class ComponentLocator(object):
pass
class SessionVarDict(collections.MutableMapping):
class SessionVarDict(MutableMapping):
def __init__(self, session, session_vars):
self._session = session
self._store = copy.copy(session_vars)

View file

@ -718,9 +718,13 @@ def generate_presigned_post(self, Bucket, Key, Fields=None, Conditions=None,
def _should_use_global_endpoint(client):
use_dualstack_endpoint = False
if client.meta.config.s3 is not None:
use_dualstack_endpoint = client.meta.config.s3.get(
'use_dualstack_endpoint', False)
return (client.meta.partition == 'aws' and
not use_dualstack_endpoint)
if client.meta.partition != 'aws':
return False
s3_config = client.meta.config.s3
if s3_config:
if s3_config.get('use_dualstack_endpoint', False):
return False
if s3_config.get('us_east_1_regional_endpoint') == 'regional' and \
client.meta.config.region_name == 'us-east-1':
return False
return True

View file

@ -52,9 +52,9 @@ copyright = u'2013, Mitch Garnaat'
# built documents.
#
# The short X.Y version.
version = '1.13.'
version = '1.14.'
# The full version, including alpha/beta/rc tags.
release = '1.13.37'
release = '1.14.14'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

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