botocore-0.29.0/0000755000175000017500000000000012254751773012725 5ustar takakitakakibotocore-0.29.0/botocore/0000755000175000017500000000000012262256051014525 5ustar takakitakakibotocore-0.29.0/botocore/__init__.py0000644000175000017500000000460512254746566016663 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import re import logging __version__ = '0.29.0' class NullHandler(logging.Handler): def emit(self, record): pass # Configure default logger to do nothing log = logging.getLogger('botocore') log.addHandler(NullHandler()) _first_cap_regex = re.compile('(.)([A-Z][a-z]+)') _number_cap_regex = re.compile('([a-z])([0-9]+)') _end_cap_regex = re.compile('([a-z0-9])([A-Z])') ScalarTypes = ('string', 'integer', 'boolean', 'timestamp', 'float', 'double') def xform_name(name, sep='_'): """ Convert camel case to a "pythonic" name. """ s1 = _first_cap_regex.sub(r'\1' + sep + r'\2', name) s2 = _number_cap_regex.sub(r'\1' + sep + r'\2', s1) return _end_cap_regex.sub(r'\1' + sep + r'\2', s2).lower() class BotoCoreObject(object): def __init__(self, **kwargs): self.name = '' self.py_name = None self.cli_name = None self.type = None self.members = [] self.documentation = '' self.__dict__.update(kwargs) if self.py_name is None: self.py_name = xform_name(self.name, '_') if self.cli_name is None: self.cli_name = xform_name(self.name, '-') def __repr__(self): return '%s:%s' % (self.type, self.name) botocore-0.29.0/botocore/auth.py0000644000175000017500000004351712254746566016072 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import base64 import datetime from hashlib import sha256 from hashlib import sha1 import hmac import logging from email.utils import formatdate from operator import itemgetter import functools from botocore.exceptions import NoCredentialsError from botocore.utils import normalize_url_path from botocore.compat import HTTPHeaders from botocore.compat import quote, unquote, urlsplit logger = logging.getLogger(__name__) EMPTY_SHA256_HASH = ( 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855') # This is the buffer size used when calculating sha256 checksums. # Experimenting with various buffer sizes showed that this value generally # gave the best result (in terms of performance). PAYLOAD_BUFFER = 1024 * 1024 class BaseSigner(object): REQUIRES_REGION = False def add_auth(self, request): raise NotImplementedError("add_auth") class SigV2Auth(BaseSigner): """ Sign a request with Signature V2. """ def __init__(self, credentials): self.credentials = credentials if self.credentials is None: raise NoCredentialsError def calc_signature(self, request, params): logger.debug("Calculating signature using v2 auth.") split = urlsplit(request.url) path = split.path if len(path) == 0: path = '/' string_to_sign = '%s\n%s\n%s\n' % (request.method, split.netloc, path) lhmac = hmac.new(self.credentials.secret_key.encode('utf-8'), digestmod=sha256) pairs = [] for key in sorted(params): value = params[key] pairs.append(quote(key, safe='') + '=' + quote(value, safe='-_~')) qs = '&'.join(pairs) string_to_sign += qs logger.debug('String to sign: %s', string_to_sign) lhmac.update(string_to_sign.encode('utf-8')) b64 = base64.b64encode(lhmac.digest()).strip().decode('utf-8') return (qs, b64) def add_auth(self, request): # The auth handler is the last thing called in the # preparation phase of a prepared request. # Because of this we have to parse the query params # from the request body so we can update them with # the sigv2 auth params. if request.data: # POST params = request.data else: # GET params = request.param params['AWSAccessKeyId'] = self.credentials.access_key params['SignatureVersion'] = '2' params['SignatureMethod'] = 'HmacSHA256' params['Timestamp'] = datetime.datetime.utcnow().isoformat() if self.credentials.token: params['SecurityToken'] = self.credentials.token qs, signature = self.calc_signature(request, params) params['Signature'] = signature return request class SigV3Auth(BaseSigner): def __init__(self, credentials): self.credentials = credentials if self.credentials is None: raise NoCredentialsError def add_auth(self, request): if 'Date' not in request.headers: request.headers['Date'] = formatdate(usegmt=True) if self.credentials.token: request.headers['X-Amz-Security-Token'] = self.credentials.token new_hmac = hmac.new(self.credentials.secret_key.encode('utf-8'), digestmod=sha256) new_hmac.update(request.headers['Date'].encode('utf-8')) encoded_signature = base64.encodestring(new_hmac.digest()).strip() signature = ('AWS3-HTTPS AWSAccessKeyId=%s,Algorithm=%s,Signature=%s' % (self.credentials.access_key, 'HmacSHA256', encoded_signature.decode('utf-8'))) request.headers['X-Amzn-Authorization'] = signature class SigV4Auth(BaseSigner): """ Sign a request with Signature V4. """ REQUIRES_REGION = True def __init__(self, credentials, service_name, region_name): self.credentials = credentials if self.credentials is None: raise NoCredentialsError # We initialize these value here so the unit tests can have # valid values. But these will get overriden in ``add_auth`` # later for real requests. now = datetime.datetime.utcnow() self.timestamp = now.strftime('%Y%m%dT%H%M%SZ') self._region_name = region_name self._service_name = service_name def _sign(self, key, msg, hex=False): if hex: sig = hmac.new(key, msg.encode('utf-8'), sha256).hexdigest() else: sig = hmac.new(key, msg.encode('utf-8'), sha256).digest() return sig def headers_to_sign(self, request): """ Select the headers from the request that need to be included in the StringToSign. """ header_map = HTTPHeaders() split = urlsplit(request.url) for name, value in request.headers.items(): lname = name.lower() header_map[lname] = value if 'host' not in header_map: header_map['host'] = split.netloc return header_map def canonical_query_string(self, request): cqs = '' if request.params: params = request.params l = [] for param in params: value = str(params[param]) l.append('%s=%s' % (quote(param, safe='-_.~'), quote(value, safe='-_.~'))) l = sorted(l) cqs = '&'.join(l) return cqs def canonical_headers(self, headers_to_sign): """ Return the headers that need to be included in the StringToSign in their canonical form by converting all header keys to lower case, sorting them in alphabetical order and then joining them into a string, separated by newlines. """ headers = [] sorted_header_names = sorted(set(headers_to_sign)) for key in sorted_header_names: value = ','.join(v.strip() for v in sorted(headers_to_sign.get_all(key))) headers.append('%s:%s' % (key, value)) return '\n'.join(headers) def signed_headers(self, headers_to_sign): l = ['%s' % n.lower().strip() for n in set(headers_to_sign)] l = sorted(l) return ';'.join(l) def payload(self, request): if request.body and hasattr(request.body, 'seek'): position = request.body.tell() read_chunksize = functools.partial(request.body.read, PAYLOAD_BUFFER) checksum = sha256() for chunk in iter(read_chunksize, b''): checksum.update(chunk) hex_checksum = checksum.hexdigest() request.body.seek(position) return hex_checksum elif request.body: return sha256(request.body.encode('utf-8')).hexdigest() else: return EMPTY_SHA256_HASH def canonical_request(self, request): cr = [request.method.upper()] path = self._normalize_url_path(urlsplit(request.url).path) cr.append(path) cr.append(self.canonical_query_string(request)) headers_to_sign = self.headers_to_sign(request) cr.append(self.canonical_headers(headers_to_sign) + '\n') cr.append(self.signed_headers(headers_to_sign)) if 'X-Amz-Content-SHA256' in request.headers: body_checksum = request.headers['X-Amz-Content-SHA256'] else: body_checksum = self.payload(request) cr.append(body_checksum) return '\n'.join(cr) def _normalize_url_path(self, path): return normalize_url_path(path) def scope(self, args): scope = [self.credentials.access_key] scope.append(self.timestamp[0:8]) scope.append(self._region_name) scope.append(self._service_name) scope.append('aws4_request') return '/'.join(scope) def credential_scope(self, args): scope = [] scope.append(self.timestamp[0:8]) scope.append(self._region_name) scope.append(self._service_name) scope.append('aws4_request') return '/'.join(scope) def string_to_sign(self, request, canonical_request): """ Return the canonical StringToSign as well as a dict containing the original version of all headers that were included in the StringToSign. """ sts = ['AWS4-HMAC-SHA256'] sts.append(self.timestamp) sts.append(self.credential_scope(request)) sts.append(sha256(canonical_request.encode('utf-8')).hexdigest()) return '\n'.join(sts) def signature(self, string_to_sign): key = self.credentials.secret_key k_date = self._sign(('AWS4' + key).encode('utf-8'), self.timestamp[0:8]) k_region = self._sign(k_date, self._region_name) k_service = self._sign(k_region, self._service_name) k_signing = self._sign(k_service, 'aws4_request') return self._sign(k_signing, string_to_sign, hex=True) def add_auth(self, request): # Create a new timestamp for each signing event now = datetime.datetime.utcnow() self.timestamp = now.strftime('%Y%m%dT%H%M%SZ') # This could be a retry. Make sure the previous # authorization header is removed first. self._add_headers_before_signing(request) canonical_request = self.canonical_request(request) logger.debug("Calculating signature using v4 auth.") logger.debug('CanonicalRequest:\n%s', canonical_request) string_to_sign = self.string_to_sign(request, canonical_request) logger.debug('StringToSign:\n%s', string_to_sign) signature = self.signature(string_to_sign) logger.debug('Signature:\n%s', signature) l = ['AWS4-HMAC-SHA256 Credential=%s' % self.scope(request)] headers_to_sign = self.headers_to_sign(request) l.append('SignedHeaders=%s' % self.signed_headers(headers_to_sign)) l.append('Signature=%s' % signature) request.headers['Authorization'] = ', '.join(l) return request def _add_headers_before_signing(self, request): if 'Authorization' in request.headers: del request.headers['Authorization'] if 'Date' not in request.headers: request.headers['X-Amz-Date'] = self.timestamp if self.credentials.token: request.headers['X-Amz-Security-Token'] = self.credentials.token class S3SigV4Auth(SigV4Auth): def canonical_query_string(self, request): split = urlsplit(request.url) buf = '' if split.query: qsa = split.query.split('&') qsa = [a.split('=', 1) for a in qsa] quoted_qsa = [] for q in qsa: if len(q) == 2: quoted_qsa.append( '%s=%s' % (quote(q[0], safe='-_.~'), quote(unquote(q[1]), safe='-_.~'))) elif len(q) == 1: quoted_qsa.append('%s=' % quote(q[0], safe='-_.~')) if len(quoted_qsa) > 0: quoted_qsa.sort(key=itemgetter(0)) buf += '&'.join(quoted_qsa) return buf def _add_headers_before_signing(self, request): super(S3SigV4Auth, self)._add_headers_before_signing(request) request.headers['X-Amz-Content-SHA256'] = self.payload(request) def _normalize_url_path(self, path): # For S3, we do not normalize the path. return path class HmacV1Auth(BaseSigner): # List of Query String Arguments of Interest QSAOfInterest = ['acl', 'cors', 'defaultObjectAcl', 'location', 'logging', 'partNumber', 'policy', 'requestPayment', 'torrent', 'versioning', 'versionId', 'versions', 'website', 'uploads', 'uploadId', 'response-content-type', 'response-content-language', 'response-expires', 'response-cache-control', 'response-content-disposition', 'response-content-encoding', 'delete', 'lifecycle', 'tagging', 'restore', 'storageClass', 'notification'] def __init__(self, credentials, service_name=None, region_name=None): self.credentials = credentials if self.credentials is None: raise NoCredentialsError self.auth_path = None # see comment in canonical_resource below def sign_string(self, string_to_sign): new_hmac = hmac.new(self.credentials.secret_key.encode('utf-8'), digestmod=sha1) new_hmac.update(string_to_sign.encode('utf-8')) return base64.encodestring(new_hmac.digest()).strip().decode('utf-8') def canonical_standard_headers(self, headers): interesting_headers = ['content-md5', 'content-type', 'date'] hoi = [] if 'Date' not in headers: headers['Date'] = formatdate(usegmt=True) for ih in interesting_headers: found = False for key in headers: lk = key.lower() if headers[key] is not None and lk == ih: hoi.append(headers[key].strip()) found = True if not found: hoi.append('') return '\n'.join(hoi) def canonical_custom_headers(self, headers): custom_headers = {} for key in headers: lk = key.lower() if headers[key] is not None: # TODO: move hardcoded prefix to provider if lk.startswith('x-amz-'): custom_headers[lk] = ','.join(v.strip() for v in headers.get_all(key)) sorted_header_keys = sorted(custom_headers.keys()) hoi = [] for key in sorted_header_keys: hoi.append("%s:%s" % (key, custom_headers[key])) return '\n'.join(hoi) def unquote_v(self, nv): """ TODO: Do we need this? """ if len(nv) == 1: return nv else: return (nv[0], unquote(nv[1])) def canonical_resource(self, split): # don't include anything after the first ? in the resource... # unless it is one of the QSA of interest, defined above # NOTE: # The path in the canonical resource should always be the # full path including the bucket name, even for virtual-hosting # style addressing. The ``auth_path`` keeps track of the full # path for the canonical resource and would be passed in if # the client was using virtual-hosting style. if self.auth_path: buf = self.auth_path else: buf = split.path if split.query: qsa = split.query.split('&') qsa = [a.split('=', 1) for a in qsa] qsa = [self.unquote_v(a) for a in qsa if a[0] in self.QSAOfInterest] if len(qsa) > 0: qsa.sort(key=itemgetter(0)) qsa = ['='.join(a) for a in qsa] buf += '?' buf += '&'.join(qsa) return buf def canonical_string(self, method, split, headers, expires=None): cs = method.upper() + '\n' cs += self.canonical_standard_headers(headers) + '\n' custom_headers = self.canonical_custom_headers(headers) if custom_headers: cs += custom_headers + '\n' cs += self.canonical_resource(split) return cs def get_signature(self, method, split, headers, expires=None): if self.credentials.token: #TODO: remove hardcoded header name headers['x-amz-security-token'] = self.credentials.token string_to_sign = self.canonical_string(method, split, headers) logger.debug('StringToSign:\n%s', string_to_sign) return self.sign_string(string_to_sign) def add_auth(self, request): logger.debug("Calculating signature using hmacv1 auth.") split = urlsplit(request.url) logger.debug('HTTP request method: %s', request.method) signature = self.get_signature(request.method, split, request.headers) request.headers['Authorization'] = ("AWS %s:%s" % (self.credentials.access_key, signature)) # Defined at the bottom instead of the top of the module because the Auth # classes weren't defined yet. AUTH_TYPE_MAPS = { 'v2': SigV2Auth, 'v4': SigV4Auth, 'v3': SigV3Auth, 'v3https': SigV3Auth, 's3': HmacV1Auth, 's3v4': S3SigV4Auth, } botocore-0.29.0/botocore/awsrequest.py0000644000175000017500000001040512254746564017320 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import logging import six from botocore.vendored.requests import models from botocore.vendored.requests.sessions import REDIRECT_STATI from botocore.compat import HTTPHeaders, file_type from botocore.exceptions import UnseekableStreamError logger = logging.getLogger(__name__) class AWSRequest(models.RequestEncodingMixin, models.Request): def __init__(self, *args, **kwargs): self.auth_path = None if 'auth_path' in kwargs: self.auth_path = kwargs['auth_path'] del kwargs['auth_path'] models.Request.__init__(self, *args, **kwargs) headers = HTTPHeaders() if self.headers is not None: for key, value in self.headers.items(): headers[key] = value self.headers = headers def prepare(self): """Constructs a :class:`AWSPreparedRequest `.""" # Eventually I think it would be nice to add hooks into this process. p = AWSPreparedRequest(self) p.prepare_method(self.method) p.prepare_url(self.url, self.params) p.prepare_headers(self.headers) p.prepare_cookies(self.cookies) p.prepare_body(self.data, self.files) p.prepare_auth(self.auth) return p @property def body(self): p = models.PreparedRequest() p.prepare_headers({}) p.prepare_body(self.data, self.files) return p.body class AWSPreparedRequest(models.PreparedRequest): """Represents a prepared request. :ivar method: HTTP Method :ivar url: The full url :ivar headers: The HTTP headers to send. :ivar body: The HTTP body. :ivar hooks: The set of callback hooks. In addition to the above attributes, the following attributes are available: :ivar query_params: The original query parameters. :ivar post_param: The original POST params (dict). """ def __init__(self, original_request): self.original = original_request super(AWSPreparedRequest, self).__init__() self.hooks.setdefault('response', []).append( self.reset_stream_on_redirect) def reset_stream_on_redirect(self, response, **kwargs): if response.status_code in REDIRECT_STATI and \ isinstance(self.body, file_type): logger.debug("Redirect received, rewinding stream: %s", self.body) self.reset_stream() def reset_stream(self): # Trying to reset a stream when there is a no stream will # just immediately return. It's not an error, it will produce # the same result as if we had actually reset the stream (we'll send # the entire body contents again if we need to). # Same case if the body is a string/bytes type. if self.body is None or isinstance(self.body, six.text_type) or \ isinstance(self.body, six.binary_type): return try: logger.debug("Rewinding stream: %s", self.body) self.body.seek(0) except Exception as e: logger.debug("Unable to rewind stream: %s", e) raise UnseekableStreamError(stream_object=self.body) botocore-0.29.0/botocore/base.py0000644000175000017500000001543712254746564016041 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # """ Responsible for finding and loading all JSON data. This module serves as the abstraction layer over the underlying data needed by the rest of the UNCLE system. Currently, this data is in the form of JSON data files these kinds of details must be hidden from the rest of the system. All of the data is presented to the rest of the system in a hierarchical, filesystem-like, manner. The basic hierarchy is: * provider * service * operation * parameter * ... You can reference this hierarchical data using a path similar to a file system, e.g. provider/service/operation/parameter/... etc. The main interface into this module is the ``get_data`` function which takes a path specificiation as it's only parameter. This function will either return the specified data or raise an exception if the data cannot be found or loaded. Examples ======== Get the service description for ec2:: data = get_data('aws/ec2') Get the operations for ec2:: data = get_data('aws/ec2/operations') Get a specific operation:: data = get_data('aws/ec2/operations/DescribeInstances') Get the member args for an operations:: data = get_data('aws/ec2/operations/DescribeInstances/input/members') """ import os import glob import logging from botocore.compat import OrderedDict, json import botocore.exceptions logger = logging.getLogger(__name__) _data_cache = {} _search_paths = [] def _load_data(session, data_path): logger.debug('Attempting to load: %s', data_path) data = {} file_name = data_path + '.json' for path in get_search_path(session): file_path = os.path.join(path, file_name) dir_path = os.path.join(path, data_path) # Is the path a directory? if os.path.isdir(dir_path): logger.debug('Found data dir: %s', dir_path) try: data = [] for pn in sorted(glob.glob(os.path.join(dir_path, '*.json'))): fn = os.path.split(pn)[1] fn = os.path.splitext(fn)[0] if not fn.startswith('_'): data.append(fn) except: logger.error('Unable to load dir: %s', dir_path, exc_info=True) break elif os.path.isfile(file_path): fp = open(file_path) try: new_data = json.load(fp, object_pairs_hook=OrderedDict) fp.close() logger.debug('Found data file: %s', file_path) if data is not None: data.update(new_data) else: data = new_data break except: logger.error('Unable to load file: %s', file_path, exc_info=True) else: logger.error('Unable to find file: %s', file_path) if data: _data_cache[data_path] = data return data def _load_nested_data(session, data_path): # First we need to prime the pump, so to speak. # We need to make sure the parents of the nested reference have # been loaded before we attempt to get the nested data. mod_names = data_path.split('/') for i, md in enumerate(mod_names): mod_name = '/'.join(mod_names[0:i + 1]) _load_data(session, mod_name) data = None prefixes = [dp for dp in _data_cache.keys() if data_path.startswith(dp)] if prefixes: prefix = max(prefixes) data = _data_cache[prefix] attrs = [s for s in data_path.split('/') if s not in prefix.split('/')] for attr in attrs: if isinstance(data, dict): if attr in data: data = data[attr] else: data = None break elif isinstance(data, list): for item in data: if 'name' in item and item['name'] == attr: data = item break # If we have gotten here and the data is still the original # prefix data, it means we did not find the sub data. if data == _data_cache[prefix]: data = None if data is not None: _data_cache[data_path] = data return data def get_search_path(session): """ Return the complete data path used when searching for data files. """ # Automatically add ./botocore/data to the # data search path. builtin_path = os.path.join( os.path.dirname( os.path.dirname( os.path.abspath(__file__))), 'botocore', 'data') paths = [builtin_path] search_path = session.get_variable('data_path') if search_path is not None: extra_paths = search_path.split(os.pathsep) for path in extra_paths: path = os.path.expandvars(path) path = os.path.expanduser(path) paths.append(path) return paths def get_data(session, data_path): """ Finds, loads and returns the data associated with ``data_path``. If the file is found, the JSON data is parsed and returned. The data is then cached so that subsequent requests get the data from the cache. :type data_path: str :param data_path: The path to the desired data, relative to the root of the JSON data directory. :raises `botocore.exceptions.DataNotFoundError` """ if data_path not in _data_cache: data = _load_data(session, data_path) if not data: data = _load_nested_data(session, data_path) if data is None: raise botocore.exceptions.DataNotFoundError(data_path=data_path) return _data_cache[data_path] botocore-0.29.0/botocore/compat.py0000644000175000017500000000635612254746564016412 0ustar takakitakaki# Copyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import sys import copy import six if six.PY3: from six.moves import http_client class HTTPHeaders(http_client.HTTPMessage): pass from urllib.parse import quote from urllib.parse import unquote from urllib.parse import urlsplit from urllib.parse import urlunsplit from urllib.parse import urljoin from urllib.parse import parse_qsl from io import IOBase as _IOBase file_type = _IOBase else: from urllib import quote from urllib import unquote from urlparse import urlsplit from urlparse import urlunsplit from urlparse import urljoin from urlparse import parse_qsl from email.message import Message file_type = file class HTTPHeaders(Message): # The __iter__ method is not available in python2.x, so we have # to port the py3 version. def __iter__(self): for field, value in self._headers: yield field try: from collections import OrderedDict except ImportError: # Python2.6 we use the 3rd party back port. from ordereddict import OrderedDict if sys.version_info[:2] == (2, 6): import simplejson as json else: import json @classmethod def from_dict(cls, d): new_instance = cls() for key, value in d.items(): new_instance[key] = value return new_instance @classmethod def from_pairs(cls, pairs): new_instance = cls() for key, value in pairs: new_instance[key] = value return new_instance HTTPHeaders.from_dict = from_dict 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! """ 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) return copy_kwargs botocore-0.29.0/botocore/config.py0000644000175000017500000000466712254746564016377 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # from six.moves import configparser import os import botocore.exceptions def get_config(session): """ If the ``config_file`` session variable exists, parse that file and return all of the data found within the file as a dictionary of dictionaries, one for each profile section found in the configuration file. :returns: A dict with keys for each profile found in the config file and the value of each key being a dict containing name value pairs found in that profile. :raises: ConfigNotFound, ConfigParseError """ config = {} path = None path = session.get_variable('config_file') if path is not None: path = os.path.expandvars(path) path = os.path.expanduser(path) if not os.path.isfile(path): raise botocore.exceptions.ConfigNotFound(path=path) cp = configparser.RawConfigParser() try: cp.read(path) except configparser.Error: raise botocore.exceptions.ConfigParseError(path=path) else: config['_path'] = path for section in cp.sections(): config[section] = {} for option in cp.options(section): config[section][option] = cp.get(section, option) return config botocore-0.29.0/botocore/credentials.py0000644000175000017500000001641512254746564017421 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import os from botocore.vendored import requests import logging from six.moves import configparser from botocore.compat import json logger = logging.getLogger(__name__) class Credentials(object): """ Holds the credentials needed to authenticate requests. In addition the Credential object knows how to search for credentials and how to choose the right credentials when multiple credentials are found. :ivar access_key: The access key part of the credentials. :ivar secret_key: The secret key part of the credentials. :ivar token: The security token, valid only for session credentials. :ivar method: A string which identifies where the credentials were found. Valid values are: iam_role|env|config|boto. """ def __init__(self, access_key=None, secret_key=None, token=None): self.access_key = access_key self.secret_key = secret_key self.token = token self.method = None self.profiles = [] def _search_md(url='http://169.254.169.254/latest/meta-data/iam/security-credentials/'): d = {} try: r = requests.get(url, timeout=.1) if r.status_code == 200 and r.content: fields = r.content.decode('utf-8').split('\n') for field in fields: if field.endswith('/'): d[field[0:-1]] = _search_md(url + field) else: val = requests.get(url + field).content.decode('utf-8') if val[0] == '{': val = json.loads(val) else: p = val.find('\n') if p > 0: val = r.content.decode('utf-8').split('\n') d[field] = val except (requests.Timeout, requests.ConnectionError): pass return d def search_iam_role(**kwargs): credentials = None metadata = kwargs.get('metadata', None) if metadata is None: metadata = _search_md() if metadata: for role_name in metadata: credentials = Credentials(metadata[role_name]['AccessKeyId'], metadata[role_name]['SecretAccessKey'], metadata[role_name]['Token']) credentials.method = 'iam-role' logger.info('Found IAM Role: %s', role_name) return credentials def search_environment(**kwargs): """ Search for credentials in explicit environment variables. """ session = kwargs.get('session') credentials = None access_key = session.get_variable('access_key', ('env',)) secret_key = session.get_variable('secret_key', ('env',)) token = session.get_variable('token', ('env',)) if access_key and secret_key: credentials = Credentials(access_key, secret_key, token) credentials.method = 'env' logger.info('Found credentials in Environment variables.') return credentials def search_credentials_file(**kwargs): """ Search for a credential file used by original EC2 CLI tools. """ credentials = None if 'AWS_CREDENTIAL_FILE' in os.environ: full_path = os.path.expanduser(os.environ['AWS_CREDENTIAL_FILE']) try: lines = map(str.strip, open(full_path).readlines()) except IOError: logger.warn('Unable to load AWS_CREDENTIAL_FILE (%s).', full_path) else: config = dict(line.split('=', 1) for line in lines if '=' in line) access_key = config.get('AWSAccessKeyId') secret_key = config.get('AWSSecretKey') if access_key and secret_key: credentials = Credentials(access_key, secret_key) credentials.method = 'credentials-file' logger.info('Found credentials in AWS_CREDENTIAL_FILE.') return credentials def search_file(**kwargs): """ If there is are credentials in the configuration associated with the session, use those. """ credentials = None session = kwargs.get('session') access_key = session.get_variable('access_key', methods=('config',)) secret_key = session.get_variable('secret_key', methods=('config',)) token = session.get_variable('token', ('config',)) if access_key and secret_key: credentials = Credentials(access_key, secret_key, token) credentials.method = 'config' logger.info('Found credentials in config file.') return credentials def search_boto_config(**kwargs): """ Look for credentials in boto config file. """ credentials = access_key = secret_key = None if 'BOTO_CONFIG' in os.environ: paths = [os.environ['BOTO_CONFIG']] else: paths = ['/etc/boto.cfg', '~/.boto'] paths = [os.path.expandvars(p) for p in paths] paths = [os.path.expanduser(p) for p in paths] cp = configparser.RawConfigParser() cp.read(paths) if cp.has_section('Credentials'): if cp.has_option('Credentials', 'aws_access_key_id'): access_key = cp.get('Credentials', 'aws_access_key_id') if cp.has_option('Credentials', 'aws_secret_access_key'): secret_key = cp.get('Credentials', 'aws_secret_access_key') if access_key and secret_key: credentials = Credentials(access_key, secret_key) credentials.method = 'boto' logger.info('Found credentials in boto config file.') return credentials AllCredentialFunctions = [search_environment, search_credentials_file, search_file, search_boto_config, search_iam_role] _credential_methods = (('env', search_environment), ('config', search_file), ('credentials-file', search_credentials_file), ('boto', search_boto_config), ('iam-role', search_iam_role)) def get_credentials(session, metadata=None): credentials = None for cred_method, cred_fn in _credential_methods: credentials = cred_fn(session=session, metadata=metadata) if credentials: break return credentials botocore-0.29.0/botocore/data/0000755000175000017500000000000012254751773015452 5ustar takakitakakibotocore-0.29.0/botocore/data/aws/0000755000175000017500000000000012254751773016244 5ustar takakitakakibotocore-0.29.0/botocore/data/aws/_regions.json0000644000175000017500000000150612254746566020752 0ustar takakitakaki{ "us-east-1": { "description": "US-East (Northern Virginia)" }, "ap-northeast-1": { "description": "Asia Pacific (Tokyo)" }, "sa-east-1": { "description": "South America (Sao Paulo)" }, "ap-southeast-1": { "description": "Asia Pacific (Singapore)" }, "ap-southeast-2": { "description": "Asia Pacific (Sydney)" }, "us-west-2": { "description": "US-West (Oregon)" }, "us-west-1": { "description": "US-West (Northern California)" }, "eu-west-1": { "description": "EU (Ireland)" }, "us-gov-west-1": { "description": "AWS GovCloud" }, "fips-us-gov-west-1": { "description": "AWS GovCloud (FIPS 140-2) S3 Only" }, "cn-north-1": { "description": "China (Beijing)" } } botocore-0.29.0/botocore/data/aws/_retry.json0000644000175000017500000001367412254746564020460 0ustar takakitakaki{ "definitions": { "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } }, "throttling_exception": { "applies_when": { "response": { "service_error_code": "ThrottlingException", "http_status_code": 400 } } }, "general_socket_errors": { "applies_when": { "socket_errors": ["GENERAL_CONNECTION_ERROR"] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": {"$ref": "general_socket_errors"}, "general_server_error": {"$ref": "general_server_error"}, "service_unavailable": {"$ref": "service_unavailable"}, "limit_exceeded": {"$ref": "limit_exceeded"} } }, "autoscaling": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "emr": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "rds": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "elasticache": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "redshift": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "elasticbeanstalk": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "cloudformation": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "datapipeline": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "opsworks": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "iam": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "sts": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "swf": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "sns": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "ses": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "cloudwatch": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "route53": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "directconnect": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "elb": { "__default__": { "policies": { "throttling": {"$ref": "throttling"} } } }, "dynamodb": { "__default__": { "max_attempts": 10, "delay": { "type": "exponential", "base": 0.05, "growth_factor": 2 }, "policies": { "throughput_exceeded": { "applies_when": { "response": { "service_error_code": "ProvisionedThroughputExceededException", "http_status_code": 400 } } }, "throttling": {"$ref": "throttling_exception"}, "crc32": { "applies_when": { "response": { "crc32body": "x-amz-crc32" } } } } } }, "glacier": { "__default__": { "policies": { "throttling": {"$ref": "throttling_exception"} } } }, "storagegateway": { "__default__": { "policies": { "throttling": {"$ref": "throttling_exception"} } } }, "ec2": { "__default__": { "policies": { "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "RequestLimitExceeded", "http_status_code": 503 } } } } } }, "cloudsearch": { "__default__": { "policies": { "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "BandwidthLimitExceeded", "http_status_code": 509 } } } } } }, "sqs": { "__default__": { "policies": { "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "RequestThrottled", "http_status_code": 403 } } } } } }, "s3": { "__default__": { "policies": { "timeouts": { "applies_when": { "response": { "http_status_code": 400, "service_error_code": "RequestTimeout" } } } } } } } } botocore-0.29.0/botocore/data/aws/autoscaling.json0000644000175000017500000071666412254746566021500 0ustar takakitakaki{ "api_version": "2011-01-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Auto Scaling", "endpoint_prefix": "autoscaling", "documentation": "\n Auto Scaling\n

\n This guide provides detailed information \n about Auto Scaling actions, data types, parameters, and errors. For detailed information \n about Auto Scaling features and their associated API calls, go to the \n Auto Scaling Developer Guide.\n

\n

\n Auto Scaling is a web service designed\n to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon EC2) instances based on\n user-defined policies, schedules, and health checks. \n This service is used in conjunction with Amazon CloudWatch \n and Elastic Load Balancing services.\n

\n

This reference is based on the current WSDL, which is available at:

\n

http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl\n

\n

Endpoints

\n

For information about this product's regions and endpoints, go to \n Regions and Endpoints \n in the Amazon Web Services General Reference.\n

\n ", "operations": { "CreateAutoScalingGroup": { "name": "CreateAutoScalingGroup", "input": { "shape_name": "CreateAutoScalingGroupType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the launch configuration to use with the Auto Scaling group.\n

\n ", "required": true }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n

\n The minimum size of the Auto Scaling group.\n

\n ", "required": true }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n

\n The maximum size of the Auto Scaling group.\n

\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n The number of Amazon EC2 instances that should be\n running in the group.\n

\n " }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n

\n The amount of time, in seconds, after a scaling activity completes\n before any further trigger-related scaling activities can start.\n

\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "documentation": "\n

\n A list of Availability Zones for the Auto Scaling group.\n This is required unless you have specified subnets.\n

\n " }, "LoadBalancerNames": { "shape_name": "LoadBalancerNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n A list of load balancers to use.\n

\n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

The service you want the health status from,\n Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.

\n " }, "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", "documentation": "\n

Length of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health.

\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

Physical location of your cluster placement group\n created in Amazon EC2. For more information about cluster placement group, see \n Using Cluster Instances

\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

A comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).

\n

If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n

\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

A standalone termination policy or a list of termination policies used to select the instance to terminate. \n The policies are executed in the order that they are listed.\n

\n

\n For more information on configuring a termination policy for your Auto Scaling group, go to \n Instance Termination Policy for Your Auto Scaling Group in the \n the Auto Scaling Developer Guide. \n

\n \n " }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n

\n " }, "Key": { "shape_name": "TagKey", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 128, "documentation": "\n

\n The key of the tag.\n

\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n The value of the tag. \n

\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n

\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n

\n " } }, "documentation": "\n

\n The tag applied to an Auto Scaling group.\n

\n " }, "documentation": "\n

\n The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, \n and a propagate flag. Valid values: key=value, value=value, propagate=true or false. Value and propagate are optional parameters.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The named Auto Scaling group or launch configuration already exists.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " } ], "documentation": "\n

\n Creates a new Auto Scaling group with the specified name and other attributes.\n When the creation request is completed,\n the Auto Scaling group is ready to be used in other calls.\n

\n \n The Auto Scaling group name must be unique within \n the scope of your AWS account, and under\n the quota of Auto Scaling groups allowed for your account.\n \n " }, "CreateLaunchConfiguration": { "name": "CreateLaunchConfiguration", "input": { "shape_name": "CreateLaunchConfigurationType", "type": "structure", "members": { "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the launch configuration to create.\n

\n ", "required": true }, "ImageId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Unique ID of the\n Amazon Machine Image (AMI)\n which was assigned during registration.\n For more information about Amazon EC2 images,\n please see\n \n Amazon EC2 product documentation.\n

\n ", "required": true }, "KeyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Amazon EC2 key pair.\n

\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n

\n The names of the security groups with which to associate Amazon EC2 or Amazon VPC \n\t\tinstances. Specify Amazon EC2 security groups using security group \n names, such as websrv. Specify Amazon VPC security groups using \n security group IDs, such as sg-12345678.\n For more information about Amazon EC2 security groups,\n go to \n \n Using Security Groups in the Amazon EC2 product documentation. For more information about Amazon VPC security groups,\n go to \n \n Security Groups in the Amazon VPC product documentation.\n

\n " }, "UserData": { "shape_name": "XmlStringUserData", "type": "blob", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "max_length": 21847, "documentation": "\n

\n The user data available to the launched Amazon EC2 instances.\n For more information about Amazon EC2 user data,\n please see\n \n Amazon EC2 product documentation.\n

\n " }, "InstanceType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The instance type of the Amazon EC2 instance.\n For more information about Amazon EC2 instance types,\n please see\n \n Amazon EC2 product documentation\n

\n ", "required": true }, "KernelId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The ID of the kernel associated with the Amazon EC2 AMI.\n

\n " }, "RamdiskId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The ID of the RAM disk associated with the Amazon EC2 AMI.\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappings", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

The virtual name associated with the device.\n

\n " }, "DeviceName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the device within Amazon EC2.\n

\n ", "required": true }, "Ebs": { "shape_name": "Ebs", "type": "structure", "members": { "SnapshotId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The snapshot ID.\n

\n " }, "VolumeSize": { "shape_name": "BlockDeviceEbsVolumeSize", "type": "integer", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The volume size, in gigabytes.\n

\n " } }, "documentation": "\n

\n The Elastic Block Storage volume information.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMapping data type.\n

\n " }, "documentation": "\n

\n A list of mappings that specify how block devices are exposed to the instance.\n Each mapping is made up of a VirtualName, a DeviceName,\n and an ebs data structure that contains information about the\n associated Elastic Block Storage volume.\n For more information about Amazon EC2 BlockDeviceMappings,\n go to\n \n Block Device Mapping in the Amazon EC2 product documentation.\n

\n " }, "InstanceMonitoring": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "Enabled": { "shape_name": "MonitoringEnabled", "type": "boolean", "documentation": "\n

\n If True, instance monitoring is enabled.\n

\n " } }, "documentation": "\n

Enables detailed monitoring, which is enabled by default.

\n

\n When detailed monitoring is enabled, CloudWatch will generate metrics every minute and your account will be charged a fee. \n When you disable detailed monitoring, by specifying False, Cloudwatch will generate metrics every 5 minutes. For \n information about monitoring, see the Amazon CloudWatch product page.\n

\n " }, "SpotPrice": { "shape_name": "SpotPrice", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the \n price you specify exceeds the current Spot market price. For more information on launching Spot Instances, go to\n Using Auto Scaling to Launch Spot Instances in the Auto Scaling Developer Guide.\n

\n " }, "IamInstanceProfile": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. \n For information on launching EC2 instances with an IAM role, go to Launching Auto Scaling Instances With an IAM Role\n in the Auto Scaling Developer Guide.

\n " }, "EbsOptimized": { "shape_name": "EbsOptimized", "type": "boolean", "documentation": "\n

\n Whether the instance is optimized for EBS I/O. This optimization provides \n dedicated throughput to Amazon EBS and an optimized configuration stack to provide \n optimal EBS I/O performance. This optimization is not available with all instance \n types. Additional usage charges apply when using an EBS Optimized instance. \n For information about EBS-optimized instances, go to EBS-Optimized Instances \n in the Amazon Elastic Compute Cloud User Guide.

\n \n " }, "AssociatePublicIpAddress": { "shape_name": "AssociatePublicIpAddress", "type": "boolean", "documentation": null } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The named Auto Scaling group or launch configuration already exists.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " } ], "documentation": "\n

\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n

\n

You can create a launch configuration with Amazon EC2 security groups or with \n Amazon VPC security groups. However, you can't use Amazon EC2 security groups together with \n Amazon VPC security groups, or vice versa.

\n \n At this time, Auto Scaling launch configurations don't support compressed \n (e.g. zipped) user data files.\n \n " }, "CreateOrUpdateTags": { "name": "CreateOrUpdateTags", "input": { "shape_name": "CreateOrUpdateTagsType", "type": "structure", "members": { "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n

\n " }, "Key": { "shape_name": "TagKey", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 128, "documentation": "\n

\n The key of the tag.\n

\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n The value of the tag. \n

\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n

\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n

\n " } }, "documentation": "\n

\n The tag applied to an Auto Scaling group.\n

\n " }, "documentation": "\n

\n The tag to be created or updated. Each tag should be defined by its resource type, resource ID, key, value, \n and a propagate flag. The resource type and resource ID identify the type and name of resource for which the \n tag is created. Currently, auto-scaling-group is the only supported resource type. The valid \n value for the resource ID is groupname.\n

\n \n

The PropagateAtLaunch flag defines whether the new tag will be applied to instances launched by \n the Auto Scaling group. Valid values are true or false. However, instances that are already \n running will not get the new or updated tag. Likewise, when you modify a tag, the updated version will be \n applied only to new instances launched by the Auto Scaling group after the change. Running instances that had \n the previous version of the tag will continue to have the older tag. \n

\n

When you create a tag and a tag of the same name already exists, the operation overwrites the previous tag \n definition, but you will not get an error message.\n

\n ", "required": true } }, "documentation": "\n

\n

\n " }, "output": null, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " }, { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The named Auto Scaling group or launch configuration already exists.\n

\n " } ], "documentation": "\n

\n Creates new tags or updates existing tags for an Auto Scaling group.\n

\n \n A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. \n Value and the propagate flag are optional parameters. See the Request Parameters for more information.\n \n \n " }, "DeleteAutoScalingGroup": { "name": "DeleteAutoScalingGroup", "input": { "shape_name": "DeleteAutoScalingGroupType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "ForceDelete": { "shape_name": "ForceDelete", "type": "boolean", "documentation": "\n

Starting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. \n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n

\n " }, { "shape_name": "ResourceInUseFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n This is returned when you cannot delete a launch\n configuration or Auto Scaling group because it is being used.\n

\n " } ], "documentation": "\n

\n Deletes the specified Auto Scaling group if the group has no\n instances and no scaling activities in progress.\n

\n \n To remove all instances before calling DeleteAutoScalingGroup,\n you can call UpdateAutoScalingGroup to set the minimum and \n maximum size of the AutoScalingGroup to zero.\n \n " }, "DeleteLaunchConfiguration": { "name": "DeleteLaunchConfiguration", "input": { "shape_name": "LaunchConfigurationNameType", "type": "structure", "members": { "LaunchConfigurationName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the launch configuration.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "ResourceInUseFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n This is returned when you cannot delete a launch\n configuration or Auto Scaling group because it is being used.\n

\n " } ], "documentation": "\n

\n Deletes the specified LaunchConfiguration.\n

\n

\n The specified launch configuration must not be \n attached to an Auto Scaling group. When this call completes,\n the launch configuration is no longer available for use.\n

\n " }, "DeleteNotificationConfiguration": { "name": "DeleteNotificationConfiguration", "input": { "shape_name": "DeleteNotificationConfigurationType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name of the Auto Scaling group.

\n ", "required": true }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

\n ", "required": true } }, "documentation": "\n \t

\n " }, "output": null, "errors": [], "documentation": "\n

Deletes notifications created by PutNotificationConfiguration.

\n " }, "DeletePolicy": { "name": "DeletePolicy", "input": { "shape_name": "DeletePolicyType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name of the Auto Scaling group.

\n " }, "PolicyName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name or PolicyARN of the policy you want to delete.

\n ", "required": true } }, "documentation": "

\n " }, "output": null, "errors": [], "documentation": "\n

Deletes a policy created by PutScalingPolicy.

\n " }, "DeleteScheduledAction": { "name": "DeleteScheduledAction", "input": { "shape_name": "DeleteScheduledActionType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name of the Auto Scaling group.

\n " }, "ScheduledActionName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name of the action you want to delete.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

\n " }, "DeleteTags": { "name": "DeleteTags", "input": { "shape_name": "DeleteTagsType", "type": "structure", "members": { "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n

\n " }, "Key": { "shape_name": "TagKey", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 128, "documentation": "\n

\n The key of the tag.\n

\n ", "required": true }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n The value of the tag. \n

\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n

\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n

\n " } }, "documentation": "\n

\n The tag applied to an Auto Scaling group.\n

\n " }, "documentation": "\n

Each tag should be defined by its resource type, resource ID, key, value, and a propagate flag. \n Valid values are: Resource type = auto-scaling-group, Resource ID = AutoScalingGroupName, \n key=value, value=value, propagate=true or false.\n

\n \n \n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": null, "errors": [], "documentation": "\n

Removes the specified tags or a set of tags from a set of resources.

\n " }, "DescribeAdjustmentTypes": { "name": "DescribeAdjustmentTypes", "input": null, "output": { "shape_name": "DescribeAdjustmentTypesAnswer", "type": "structure", "members": { "AdjustmentTypes": { "shape_name": "AdjustmentTypes", "type": "list", "members": { "shape_name": "AdjustmentType", "type": "structure", "members": { "AdjustmentType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

A policy adjustment type. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n " } }, "documentation": "\n

\n Specifies whether the PutScalingPolicy \n ScalingAdjustment parameter is \n an absolute number or a percentage of the current\n capacity. \n

\n " }, "documentation": "\n

\n A list of specific policy adjustment types.\n

\n " } }, "documentation": "\n

\n The output of the DescribeAdjustmentTypes action.\n

\n " }, "errors": [], "documentation": "\n

\n Returns policy adjustment types for use in the PutScalingPolicy action.\n

\n " }, "DescribeAutoScalingGroups": { "name": "DescribeAutoScalingGroups", "input": { "shape_name": "AutoScalingGroupNamesType", "type": "structure", "members": { "AutoScalingGroupNames": { "shape_name": "AutoScalingGroupNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A list of Auto Scaling group names.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of records to return.\n

\n " } }, "documentation": "\n

\n The AutoScalingGroupNamesType data type.\n

\n " }, "output": { "shape_name": "AutoScalingGroupsType", "type": "structure", "members": { "AutoScalingGroups": { "shape_name": "AutoScalingGroups", "type": "list", "members": { "shape_name": "AutoScalingGroup", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies the name of the group.\n

\n ", "required": true }, "AutoScalingGroupARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The Amazon Resource Name (ARN) of the Auto Scaling group.\n

\n " }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies the name of the associated LaunchConfiguration.\n

\n ", "required": true }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n

\n Contains the minimum size of the Auto Scaling group.\n

\n ", "required": true }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n

\n Contains the maximum size of the Auto Scaling group.\n

\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n Specifies the desired capacity for the Auto Scaling group.\n

\n ", "required": true }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n

\n The number of seconds after a scaling activity completes\n before any further scaling activities can start.\n

\n ", "required": true }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "documentation": "\n

\n Contains a list of Availability Zones for the group.\n

\n ", "required": true }, "LoadBalancerNames": { "shape_name": "LoadBalancerNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n A list of load balancers associated with this Auto Scaling group.\n

\n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The service of interest for the health status check,\n either \"EC2\" for Amazon EC2 or \"ELB\" for Elastic Load Balancing.\n

\n ", "required": true }, "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", "documentation": "\n

\n The length of time that Auto Scaling waits\n before checking an instance's health status.\n The grace period begins when an instance\n comes into service.\n

\n " }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n

\n Specifies the ID of the Amazon EC2 instance.\n

\n ", "required": true }, "AvailabilityZone": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Availability Zones associated with this instance.\n

\n ", "required": true }, "LifecycleState": { "shape_name": "LifecycleState", "type": "string", "enum": [ "Pending", "Quarantined", "InService", "Terminating", "Terminated" ], "documentation": "\n

\n Contains a description of the current lifecycle state.\n

\n ", "required": true }, "HealthStatus": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The instance's health status.\n

\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The launch configuration associated with this instance.\n

\n ", "required": true } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n Provides a summary list of Amazon EC2 instances.\n

\n " }, "CreatedTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Specifies the date and time the Auto Scaling group was created.\n

\n ", "required": true }, "SuspendedProcesses": { "shape_name": "SuspendedProcesses", "type": "list", "members": { "shape_name": "SuspendedProcess", "type": "structure", "members": { "ProcessName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the suspended process.\n

\n " }, "SuspensionReason": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The reason that the process was suspended.\n

\n " } }, "documentation": "\n

\n An Auto Scaling process that has been suspended.\n For more information, see ProcessType.\n

\n " }, "documentation": "\n

\n Suspended processes associated with this Auto Scaling group.\n

\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the cluster placement group, if applicable. For\n more information, go to \n \n Using Cluster Instances in the Amazon EC2 User Guide.\n

\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a \n comma-separated list. \n

\n

\n When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the \n subnets' Availability Zones match the values you specify for AvailabilityZones.\n

\n " }, "EnabledMetrics": { "shape_name": "EnabledMetrics", "type": "list", "members": { "shape_name": "EnabledMetric", "type": "structure", "members": { "Metric": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the enabled metric.\n

\n " }, "Granularity": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The granularity of the enabled metric. \n

\n " } }, "documentation": "\n

\n The EnabledMetric data type.\n

\n " }, "documentation": "\n

\n A list of metrics enabled for this Auto Scaling group.\n

\n " }, "Status": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n A list of status conditions for the Auto Scaling group.\n

\n " }, "Tags": { "shape_name": "TagDescriptionList", "type": "list", "members": { "shape_name": "TagDescription", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n

\n " }, "Key": { "shape_name": "TagKey", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 128, "documentation": "\n

\n The key of the tag.\n

\n " }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n The value of the tag.\n

\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n

\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n

\n " } }, "documentation": "\n

\n The tag applied to an Auto Scaling group.\n

\n " }, "documentation": "\n

\n A list of tags for the Auto Scaling group.\n

\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A standalone termination policy or a list of termination policies for this Auto Scaling group.\n

\n " } }, "documentation": "\n

\n The AutoScalingGroup data type.\n

\n " }, "documentation": "\n

\n A list of Auto Scaling groups.\n

\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " } }, "documentation": "\n

\n The AutoScalingGroupsType data type.\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns a full description of each Auto Scaling group in the given list. \n This includes all Amazon EC2 instances that are members of the group. \n If a list of names is not provided, the service returns the\n full details of all Auto Scaling groups.\n

\n

\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AutoScalingGroups", "py_input_token": "next_token" } }, "DescribeAutoScalingInstances": { "name": "DescribeAutoScalingInstances", "input": { "shape_name": "DescribeAutoScalingInstancesType", "type": "structure", "members": { "InstanceIds": { "shape_name": "InstanceIds", "type": "list", "members": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": null }, "documentation": "\n

\n The list of Auto Scaling instances to describe. \n If this list is omitted, all auto scaling instances are described. \n The list of requested instances cannot contain more than\n 50 items. If unknown instances are requested,\n they are ignored with no error.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of Auto Scaling instances to be described\n with each call.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The token returned by a previous call \n to indicate that there is more data available.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "AutoScalingInstancesType", "type": "structure", "members": { "AutoScalingInstances": { "shape_name": "AutoScalingInstances", "type": "list", "members": { "shape_name": "AutoScalingInstanceDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n

\n The instance ID of the Amazon EC2 instance.\n

\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group associated with this instance.\n

\n ", "required": true }, "AvailabilityZone": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The Availability Zone in which this instance resides.\n

\n ", "required": true }, "LifecycleState": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The life cycle state of this instance.\n

\n ", "required": true }, "HealthStatus": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The health status of this instance. \n \"Healthy\" means that the instance is healthy and should\n remain in service.\n \"Unhealthy\" means that the instance is unhealthy. Auto\n Scaling should terminate and replace it. \n

\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The launch configuration associated with this instance.\n

\n ", "required": true } }, "documentation": "\n

\n The AutoScalingInstanceDetails data type.\n

\n " }, "documentation": "\n

\n A list of Auto Scaling instances.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " } }, "documentation": "\n

\n The AutoScalingInstancesType data type.\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns a description of each Auto Scaling instance in the InstanceIds list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n

\n

\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AutoScalingInstances", "py_input_token": "next_token" } }, "DescribeAutoScalingNotificationTypes": { "name": "DescribeAutoScalingNotificationTypes", "input": null, "output": { "shape_name": "DescribeAutoScalingNotificationTypesAnswer", "type": "structure", "members": { "AutoScalingNotificationTypes": { "shape_name": "AutoScalingNotificationTypes", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n Notification types supported by Auto Scaling. They are: \n autoscaling:EC2_INSTANCE_LAUNCH, autoscaling:EC2_INSTANCE_LAUNCH_ERROR, autoscaling:EC2_INSTANCE_TERMINATE, \n autoscaling:EC2_INSTANCE_TERMINATE_ERROR, autoscaling:TEST_NOTIFICATION \n

\n " } }, "documentation": "\n

The AutoScalingNotificationTypes data type.

\n " }, "errors": [], "documentation": "\n

\n Returns a list of all notification types that are supported by Auto Scaling.\n \n

\n " }, "DescribeLaunchConfigurations": { "name": "DescribeLaunchConfigurations", "input": { "shape_name": "LaunchConfigurationNamesType", "type": "structure", "members": { "LaunchConfigurationNames": { "shape_name": "LaunchConfigurationNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A list of launch configuration names.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of launch configurations. The default is 100.\n

\n " } }, "documentation": "\n

\n The LaunchConfigurationNamesType data type.\n

\n " }, "output": { "shape_name": "LaunchConfigurationsType", "type": "structure", "members": { "LaunchConfigurations": { "shape_name": "LaunchConfigurations", "type": "list", "members": { "shape_name": "LaunchConfiguration", "type": "structure", "members": { "LaunchConfigurationName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies the name of the launch configuration.\n

\n ", "required": true }, "LaunchConfigurationARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The launch configuration's Amazon Resource Name (ARN).\n

\n " }, "ImageId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Provides the unique ID of the Amazon Machine Image (AMI)\n that was assigned during registration.\n

\n ", "required": true }, "KeyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Provides the name of the Amazon EC2 key pair.\n

\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n

\n A description of the security\n groups to associate with the Amazon EC2 instances.\n

\n " }, "UserData": { "shape_name": "XmlStringUserData", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "max_length": 21847, "documentation": "\n

\n The user data available to the launched Amazon EC2 instances.\n

\n " }, "InstanceType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies the instance type of the Amazon EC2 instance.\n

\n ", "required": true }, "KernelId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Provides the ID of the kernel associated with the Amazon EC2 AMI.\n

\n " }, "RamdiskId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Provides ID of the RAM disk associated with the Amazon EC2 AMI.\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappings", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

The virtual name associated with the device.\n

\n " }, "DeviceName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the device within Amazon EC2.\n

\n ", "required": true }, "Ebs": { "shape_name": "Ebs", "type": "structure", "members": { "SnapshotId": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The snapshot ID.\n

\n " }, "VolumeSize": { "shape_name": "BlockDeviceEbsVolumeSize", "type": "integer", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The volume size, in gigabytes.\n

\n " } }, "documentation": "\n

\n The Elastic Block Storage volume information.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMapping data type.\n

\n " }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n

\n " }, "InstanceMonitoring": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "Enabled": { "shape_name": "MonitoringEnabled", "type": "boolean", "documentation": "\n

\n If True, instance monitoring is enabled.\n

\n " } }, "documentation": "\n

\n Controls whether instances in this group are launched with\n detailed monitoring or not. \n

\n " }, "SpotPrice": { "shape_name": "SpotPrice", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

Specifies the price to bid when launching Spot Instances.

\n " }, "IamInstanceProfile": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n \n

Provides the name or the Amazon Resource Name (ARN) of the \n instance profile associated with the IAM role for the instance. \n The instance profile contains the IAM role.\n

\n " }, "CreatedTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Provides the creation date and time for this launch configuration.\n

\n ", "required": true }, "EbsOptimized": { "shape_name": "EbsOptimized", "type": "boolean", "documentation": "\n

Specifies whether the instance is optimized for EBS I/O (true) or not (false).

\n " }, "AssociatePublicIpAddress": { "shape_name": "AssociatePublicIpAddress", "type": "boolean", "documentation": null } }, "documentation": "\n

\n The LaunchConfiguration data type.\n

\n " }, "documentation": "\n

\n A list of launch configurations.\n

\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " } }, "documentation": "\n

\n The LaunchConfigurationsType data type.\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns a full description of the launch configurations, or the specified launch configurations,\n if they exist.\n

\n

\n If no name is specified, then the full details of\n all launch configurations are returned.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "LaunchConfigurations", "py_input_token": "next_token" } }, "DescribeMetricCollectionTypes": { "name": "DescribeMetricCollectionTypes", "input": null, "output": { "shape_name": "DescribeMetricCollectionTypesAnswer", "type": "structure", "members": { "Metrics": { "shape_name": "MetricCollectionTypes", "type": "list", "members": { "shape_name": "MetricCollectionType", "type": "structure", "members": { "Metric": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n " } }, "documentation": "\n

\n The MetricCollectionType data type.\n

\n " }, "documentation": "\n

The list of Metrics collected.The following metrics are supported:\n

\n \n\n " }, "Granularities": { "shape_name": "MetricGranularityTypes", "type": "list", "members": { "shape_name": "MetricGranularityType", "type": "structure", "members": { "Granularity": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The granularity of a Metric.\n

\n " } }, "documentation": "\n

\n The MetricGranularityType data type.\n

\n " }, "documentation": "\n

A list of granularities for the listed Metrics.

\n " } }, "documentation": "\n

The output of the DescribeMetricCollectionTypes action.

\n " }, "errors": [], "documentation": "\n

\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n

\n " }, "DescribeNotificationConfigurations": { "name": "DescribeNotificationConfigurations", "input": { "shape_name": "DescribeNotificationConfigurationsType", "type": "structure", "members": { "AutoScalingGroupNames": { "shape_name": "AutoScalingGroupNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that is used to mark the start of the next\n batch of returned results for pagination.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

Maximum number of records to be returned.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "DescribeNotificationConfigurationsAnswer", "type": "structure", "members": { "NotificationConfigurations": { "shape_name": "NotificationConfigurations", "type": "list", "members": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n Specifies the Auto Scaling group name.\n

\n " }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.\n

\n " }, "NotificationType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The types of events for an action to start.\n

\n " } }, "documentation": "\n

\n The NotificationConfiguration data type.\n

\n " }, "documentation": "\n

The list of notification configurations.

\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

A string that is used to mark the start of the next\n batch of returned results for pagination.

\n " } }, "documentation": "\n

The output of the DescribeNotificationConfigurations action.

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns a list of notification actions associated with Auto Scaling groups \n for specified events.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "NotificationConfigurations", "py_input_token": "next_token" } }, "DescribePolicies": { "name": "DescribePolicies", "input": { "shape_name": "DescribePoliciesType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A list of policy names or policy ARNs to be\n described. If this list is omitted, all policy names\n are described. If an auto scaling group name is\n provided, the results are limited to that group. The\n list of requested policy names cannot contain more\n than 50 items. If unknown policy names are\n requested, they are ignored with no error.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that is used to mark the start of the next\n batch of returned results for pagination.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of policies that will be described\n with each call.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "PoliciesType", "type": "structure", "members": { "ScalingPolicies": { "shape_name": "ScalingPolicies", "type": "list", "members": { "shape_name": "ScalingPolicy", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group associated with this scaling policy.\n

\n " }, "PolicyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the scaling policy.\n

\n " }, "ScalingAdjustment": { "shape_name": "PolicyIncrement", "type": "integer", "documentation": "\n

\n The number associated with the specified \n adjustment type.\n A positive value adds to the current capacity\n and a negative value removes from the current capacity.\n

\n " }, "AdjustmentType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies whether the ScalingAdjustment is \n an absolute number or a percentage of the current\n capacity. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.\n

\n " }, "Cooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n

\n The amount of time, in seconds, after a scaling activity\n completes before any further trigger-related scaling activities\n can start.\n

\n " }, "PolicyARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The Amazon Resource Name (ARN) of the policy.\n

\n " }, "Alarms": { "shape_name": "Alarms", "type": "list", "members": { "shape_name": "Alarm", "type": "structure", "members": { "AlarmName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": " \n

The name of the alarm.

\n " }, "AlarmARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The Amazon Resource Name (ARN) of the alarm.

\n " } }, "documentation": "\n

The Alarm data type.

\n " }, "documentation": "\n

\n A list of CloudWatch Alarms related to the policy.\n

\n " }, "MinAdjustmentStep": { "shape_name": "MinAdjustmentStep", "type": "integer", "documentation": "\n

\n Changes the DesiredCapacity of the Auto Scaling group by at least the specified number of instances.\n

\n " } }, "documentation": "\n

\n The ScalingPolicy data type.\n

\n " }, "documentation": "\n

\n A list of scaling policies.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results. \n

\n " } }, "documentation": "\n

\n The PoliciesType data type.\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns descriptions of what each policy does.\n This action supports pagination. If the response includes a token, \n there are more records available. To get the additional records, repeat\n the request with the response token as the NextToken parameter.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "ScalingPolicies", "py_input_token": "next_token" } }, "DescribeScalingActivities": { "name": "DescribeScalingActivities", "input": { "shape_name": "DescribeScalingActivitiesType", "type": "structure", "members": { "ActivityIds": { "shape_name": "ActivityIds", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n

\n A list containing the activity IDs of the desired scaling activities.\n If this list is omitted, all activities are described. \n If an AutoScalingGroupName is provided, the results\n are limited to that group. The list of requested\n activities cannot contain more than 50 items. If\n unknown activities are requested, they are ignored\n with no error.\n

\n " }, "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the AutoScalingGroup.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of scaling activities to return.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results for pagination.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ActivitiesType", "type": "structure", "members": { "Activities": { "shape_name": "Activities", "type": "list", "members": { "shape_name": "Activity", "type": "structure", "members": { "ActivityId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Specifies the ID of the activity.\n

\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "Description": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Contains a friendly, more verbose description of the scaling activity.\n

\n " }, "Cause": { "shape_name": "XmlStringMaxLen1023", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1023, "documentation": "\n

\n Contains the reason the activity was begun.\n

\n ", "required": true }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Provides the start time of this activity.\n

\n ", "required": true }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Provides the end time of this activity.\n

\n " }, "StatusCode": { "shape_name": "ScalingActivityStatusCode", "type": "string", "enum": [ "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "Successful", "Failed", "Cancelled" ], "documentation": "\n

\n Contains the current status of the activity.\n

\n ", "required": true }, "StatusMessage": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Contains a friendly, more verbose description of the activity status.\n

\n " }, "Progress": { "shape_name": "Progress", "type": "integer", "documentation": "\n

\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n

\n " }, "Details": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Contains details of the scaling activity.\n

\n " } }, "documentation": "\n

\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n

\n " }, "documentation": "\n

\n A list of the requested scaling activities.\n

\n ", "required": true }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Acts as a paging mechanism for large result sets.\n Set to a non-empty string if there are additional\n results waiting to be returned.\n Pass this in to subsequent calls to return additional results.\n

\n " } }, "documentation": "\n

\n The output for the DescribeScalingActivities action.\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Returns the scaling activities for the specified Auto Scaling group.\n

\n

\n If the specified ActivityIds list is empty,\n all the activities from the past six weeks are returned.\n Activities are sorted by completion time.\n Activities still in progress appear first on the list.\n

\n

\n This action supports pagination. If the response includes a token, \n there are more records available. To get the additional records, repeat\n the request with the response token as the NextToken parameter. \n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Activities", "py_input_token": "next_token" } }, "DescribeScalingProcessTypes": { "name": "DescribeScalingProcessTypes", "input": null, "output": { "shape_name": "ProcessesType", "type": "structure", "members": { "Processes": { "shape_name": "Processes", "type": "list", "members": { "shape_name": "ProcessType", "type": "structure", "members": { "ProcessName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of a process.\n

\n ", "required": true } }, "documentation": "\n

\n There are two primary Auto Scaling process types--Launch\n and Terminate. The Launch process creates a new\n Amazon EC2 instance for an Auto Scaling group, and the Terminate\n process removes an existing Amazon EC2 instance.\n

\n

\n The remaining Auto Scaling process types relate to specific Auto Scaling features:\n

\n

\n \n

\n If you suspend Launch or Terminate,\n all other process types are affected to varying degrees.\n The following descriptions discuss how each process type\n is affected by a suspension of Launch or\n Terminate.\n

\n \n

\n The AddToLoadBalancer process type adds instances to the the load balancer \n when the instances are launched. If you suspend this process, Auto Scaling will launch \n the instances but will not add them to the load balancer. If you resume the \n AddToLoadBalancer process, Auto Scaling will also resume adding new instances to the load \n balancer when they are launched. However, Auto Scaling will not add running instances that\n were launched while the process was suspended; those instances must be added manually using the \n the \n RegisterInstancesWithLoadBalancer call in the Elastic Load Balancing API Reference.\n

\n

\n The AlarmNotification process type accepts notifications from\n Amazon CloudWatch alarms that are associated with the Auto Scaling group. If you\n suspend the AlarmNotification process type, Auto Scaling will not\n automatically execute scaling policies that would be triggered by alarms.\n

\n

\n Although the AlarmNotification process type is not directly\n affected by a suspension of Launch or Terminate,\n alarm notifications are often used to signal that a change in the size\n of the Auto Scaling group is warranted. If you suspend Launch\n or Terminate, Auto Scaling might not be able to implement the alarm's\n associated policy.\n

\n

\n The AZRebalance process type seeks to maintain a balanced number of \n instances across Availability Zones within a Region. If you remove an Availability\n Zone from your Auto Scaling group or an Availability Zone otherwise\n becomes unhealthy or unavailable, Auto Scaling launches new instances in an \n unaffected Availability Zone before terminating the unhealthy or unavailable instances. \n When the unhealthy Availability Zone returns to a healthy state, Auto Scaling automatically\n redistributes the application instances evenly across all of the designated Availability Zones.\n

\n \n

\n If you call SuspendProcesses on the launch process type, the AZRebalance\n process will neither launch new instances nor terminate existing instances. \n This is because the AZRebalance process terminates existing instances only\n after launching the replacement instances. \n

\n

\n If you call SuspendProcesses on the terminate process type, the AZRebalance\n process can cause your Auto Scaling group to grow up to ten percent larger than\n the maximum size. This is because Auto Scaling allows groups to temporarily grow\n larger than the maximum size during rebalancing activities.\n If Auto Scaling cannot terminate instances, your Auto Scaling group could remain\n up to ten percent larger than the maximum size until you resume the terminate\n process type.\n

\n \n

\n The HealthCheck process type checks the health of the instances.\n Auto Scaling marks an instance as unhealthy if Amazon EC2 or Elastic Load Balancing \n informs Auto Scaling that the instance is unhealthy. The HealthCheck\n process can override the health status of an instance that you set with SetInstanceHealth.\n

\n

\n The ReplaceUnhealthy process type terminates instances that are marked\n as unhealthy and subsequently creates new instances to replace them. This process\n calls both of the primary process types--first Terminate and\n then Launch. \n

\n \n

\n The HealthCheck process type works in conjunction with the \n ReplaceUnhealthly process type to provide health check functionality.\n If you suspend either Launch or Terminate, the\n ReplaceUnhealthy process type will not function properly.\n

\n \n

\n The ScheduledActions process type performs scheduled actions that you\n create with PutScheduledUpdateGroupAction. Scheduled actions often involve\n launching new instances or terminating existing instances. If you suspend either \n Launch or Terminate, your scheduled actions might not\n function as expected.\n

\n " }, "documentation": "\n

\n A list of ProcessType names.\n

\n " } }, "documentation": "\n

\n The output of the DescribeScalingProcessTypes action.\n

\n " }, "errors": [], "documentation": "\n

Returns scaling process types for use in the ResumeProcesses \n and SuspendProcesses actions.

\n " }, "DescribeScheduledActions": { "name": "DescribeScheduledActions", "input": { "shape_name": "DescribeScheduledActionsType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ScheduledActionNames": { "shape_name": "ScheduledActionNames", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A list of scheduled actions to be described. If this\n list is omitted, all scheduled actions are described.\n The list of requested scheduled actions cannot\n contain more than 50 items. If an auto scaling\n group name is provided, the results are limited to\n that group. If unknown scheduled actions are\n requested, they are ignored with no error.\n

\n " }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n The earliest scheduled start time to return. If scheduled\n action names are provided, this field will be ignored.\n

\n " }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n The latest scheduled start time to return. If scheduled\n action names are provided, this field is ignored.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of scheduled actions to return.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "ScheduledActionsType", "type": "structure", "members": { "ScheduledUpdateGroupActions": { "shape_name": "ScheduledUpdateGroupActions", "type": "list", "members": { "shape_name": "ScheduledUpdateGroupAction", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group to be updated.\n

\n " }, "ScheduledActionName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of this scheduled action.\n

\n " }, "ScheduledActionARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The Amazon Resource Name (ARN) of this scheduled action.\n

\n " }, "Time": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Time is deprecated.

\n

The time that the action is scheduled to begin.\n Time is an alias for StartTime.\n

\n " }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n The time that the action is scheduled to begin.\n This value can be up to one month in the future.\n

\n

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.

\n \n " }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n The time that the action is scheduled to end.\n This value can be up to one month in the future.\n

\n " }, "Recurrence": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The regular schedule that an action occurs.\n

\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n

\n The minimum size of the Auto Scaling group.\n

\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n

\n The maximum size of the Auto Scaling group.\n

\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n The number of instances you prefer to maintain in your\n Auto Scaling group. \n

\n " } }, "documentation": "\n

\n This data type stores information about a\n scheduled update to an Auto Scaling group.\n

\n " }, "documentation": "\n

\n A list of scheduled actions designed to update an Auto Scaling group.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch of returned results.\n

\n " } }, "documentation": "\n

\n A scaling action that is scheduled for a future time and date.\n An action can be scheduled up to thirty days in advance.\n

\n

\n \tStarting with API version 2011-01-01, you can use recurrence \n \tto specify that a scaling action occurs regularly on a schedule. \n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of\n actions already executed, see the activity record returned in DescribeScalingActivities. \n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "ScheduledUpdateGroupActions", "py_input_token": "next_token" } }, "DescribeTags": { "name": "DescribeTags", "input": { "shape_name": "DescribeTagsType", "type": "structure", "members": { "Filters": { "shape_name": "Filters", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the filter. Valid Name values are: \n \"auto-scaling-group\", \"key\", \"value\", and \"propagate-at-launch\".\n

\n " }, "Values": { "shape_name": "Values", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": null }, "documentation": "\n

\n The value of the filter.\n

\n " } }, "documentation": "\n

The Filter data type.

\n " }, "documentation": "\n

\n The value of the filter type used to identify the tags \n to be returned. For example, you can filter so that tags are returned \n according to Auto Scaling group, the key and value, or whether \n the new tag will be applied to instances launched after the \n tag is created (PropagateAtLaunch). \n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string that marks the start of the next batch \n of returned results.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 50, "documentation": "\n

\n The maximum number of records to return.\n

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "TagsType", "type": "structure", "members": { "Tags": { "shape_name": "TagDescriptionList", "type": "list", "members": { "shape_name": "TagDescription", "type": "structure", "members": { "ResourceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The name of the Auto Scaling group.\n

\n " }, "ResourceType": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n The kind of resource to which the tag is applied. Currently, Auto Scaling \n supports the auto-scaling-group resource type.\n

\n " }, "Key": { "shape_name": "TagKey", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 128, "documentation": "\n

\n The key of the tag.\n

\n " }, "Value": { "shape_name": "TagValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n The value of the tag.\n

\n " }, "PropagateAtLaunch": { "shape_name": "PropagateAtLaunch", "type": "boolean", "documentation": "\n

\n Specifies whether the new tag will be applied to instances launched after \n the tag is created. The same behavior applies to updates: If you change a \n tag, the changed tag will be applied to all instances launched after you made \n the change.\n

\n " } }, "documentation": "\n

\n The tag applied to an Auto Scaling group.\n

\n " }, "documentation": "\n

\n The list of tags.\n

\n " }, "NextToken": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n A string used to mark the start of the next\n batch of returned results. \n

\n " } }, "documentation": "\n

\n

\n " }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The NextToken value is invalid.\n

\n " } ], "documentation": "\n

\n Lists the Auto Scaling group tags. \n

\n

\n You can use filters to limit results when describing tags. For example, you can query for \n tags of a particular Auto Scaling group. You can specify multiple values for a filter. A \n tag must match at least one of the specified values for it to be included in the results. \n

\n

\n You can also specify multiple filters. The result includes information for a particular \n tag only if it matches all your filters. If there's no match, no special message is returned.\n

\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Tags", "py_input_token": "next_token" } }, "DescribeTerminationPolicyTypes": { "name": "DescribeTerminationPolicyTypes", "input": null, "output": { "shape_name": "DescribeTerminationPolicyTypesAnswer", "type": "structure", "members": { "TerminationPolicyTypes": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n Termination policies supported by Auto Scaling. They are:\n OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, \n Default\n

\n " } }, "documentation": " \n

The TerminationPolicyTypes data type.

\n " }, "errors": [], "documentation": "\n

\n Returns a list of all termination policies supported by Auto Scaling. \n

\n " }, "DisableMetricsCollection": { "name": "DisableMetricsCollection", "input": { "shape_name": "DisableMetricsCollectionQuery", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name or ARN of the Auto Scaling Group.

\n ", "required": true }, "Metrics": { "shape_name": "Metrics", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n

\n \n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n

\n Disables monitoring of group metrics for the\n Auto Scaling group specified in AutoScalingGroupName.\n You can specify the list of affected metrics with the\n Metrics parameter.\n

\n " }, "EnableMetricsCollection": { "name": "EnableMetricsCollection", "input": { "shape_name": "EnableMetricsCollectionQuery", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

The name or ARN of the Auto Scaling group.

\n ", "required": true }, "Metrics": { "shape_name": "Metrics", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n

\n \n " }, "Granularity": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The granularity to associate with the metrics to collect.\n Currently, the only legal granularity is \"1Minute\".\n

\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n

\n Enables monitoring of group metrics for the\n Auto Scaling group specified in AutoScalingGroupName.\n You can specify the list of enabled metrics with the\n Metrics parameter.\n

\n

\n Auto scaling metrics collection can be turned on only \n if the InstanceMonitoring flag, \n in the Auto Scaling group's launch configuration, \n is set to True.\n

\n " }, "ExecutePolicy": { "name": "ExecutePolicy", "input": { "shape_name": "ExecutePolicyType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or ARN of the Auto Scaling group.\n

\n " }, "PolicyName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or PolicyARN of the policy you want to run.\n

\n ", "required": true }, "HonorCooldown": { "shape_name": "HonorCooldown", "type": "boolean", "documentation": "\n

\n Set to True if you want Auto Scaling to reject this\n request when the Auto Scaling group is in cooldown.\n

\n " } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n

\n " } ], "documentation": "\n

Runs the policy you create for your Auto Scaling group in PutScalingPolicy.

\n " }, "PutNotificationConfiguration": { "name": "PutNotificationConfiguration", "input": { "shape_name": "PutNotificationConfigurationType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "TopicARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.\n

\n ", "required": true }, "NotificationTypes": { "shape_name": "AutoScalingNotificationTypes", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

The type of events that will trigger the notification. For more information, go to \n DescribeAutoScalingNotificationTypes.

\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " } ], "documentation": "\n

\n Configures an Auto Scaling group to send notifications when \n specified events take place. Subscribers to this topic can have \n messages for events delivered to an endpoint such as a web server \n or email address.\n

\n

\n \tA new PutNotificationConfiguration overwrites an existing configuration.

\n " }, "PutScalingPolicy": { "name": "PutScalingPolicy", "input": { "shape_name": "PutScalingPolicyType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or ARN of the Auto Scaling group.\n

\n ", "required": true }, "PolicyName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the policy you want to create or update.

\n ", "required": true }, "ScalingAdjustment": { "shape_name": "PolicyIncrement", "type": "integer", "documentation": "\n

\n The number of instances by which to scale. \n AdjustmentType determines the interpretation\n of this number (e.g., as an absolute number or as\n a percentage of the existing Auto Scaling group\n size). A positive increment adds to the current\n capacity and a negative value removes from the\n current capacity.\n

\n ", "required": true }, "AdjustmentType": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Specifies whether the ScalingAdjustment is \n an absolute number or a percentage of the current\n capacity. Valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.\n

\n ", "required": true }, "Cooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n

\n The amount of time, in seconds, after a scaling \n activity completes and before the next scaling acitvity can start.\n

\n " }, "MinAdjustmentStep": { "shape_name": "MinAdjustmentStep", "type": "integer", "documentation": "\n

\n Used with AdjustmentType with the value PercentChangeInCapacity, \n the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least the number of instances specified in the value.\n

\n

\n You will get a ValidationError if you use MinAdjustmentStep on a policy with an AdjustmentType\n other than PercentChangeInCapacity.\n

\n \n " } }, "documentation": "\n " }, "output": { "shape_name": "PolicyARNType", "type": "structure", "members": { "PolicyARN": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n A policy's Amazon Resource Name (ARN).\n

\n " } }, "documentation": "\n

\n The PolicyARNType data type.\n

\n " }, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " } ], "documentation": "\n

\n Creates or updates a policy for an Auto Scaling group. \n To update an existing policy, use the existing\n policy name and set the parameter(s) you want to change. \n Any existing parameter not changed in an update to an\n existing policy is not changed in this update request.\n

\n " }, "PutScheduledUpdateGroupAction": { "name": "PutScheduledUpdateGroupAction", "input": { "shape_name": "PutScheduledUpdateGroupActionType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or ARN of the Auto Scaling group.\n

\n ", "required": true }, "ScheduledActionName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of this scaling action.\n

\n ", "required": true }, "Time": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

Time is deprecated.

\n

The time for this action to start. Time is an alias for StartTime \n and can be specified instead of StartTime, \n or vice versa. If both Time and StartTime are specified, \n their values should be identical. Otherwise,\n PutScheduledUpdateGroupAction will return an error.

\n " }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

The time for this action to start, as in --start-time 2010-06-01T00:00:00Z.

\n

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.

\n " }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

The time for this action to end.

\n " }, "Recurrence": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\t\tThe time when recurring future actions will start. Start time is specified by the user following the Unix cron syntax format. For information \n\t\tabout cron syntax, go to Wikipedia, The Free Encyclopedia.

\n

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring\n action will start and stop.

\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n

\n The minimum size for the new Auto Scaling group.\n

\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n

\n The maximum size for the Auto Scaling group.\n

\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n The number of Amazon EC2 instances that should be running in the group.\n

\n " } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "AlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The named Auto Scaling group or launch configuration already exists.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n

\n " } ], "documentation": "\n

\n Creates a scheduled scaling action for an Auto Scaling group. \n If you leave a parameter unspecified, the corresponding value \n remains unchanged in the affected Auto Scaling group.\n

\n " }, "ResumeProcesses": { "name": "ResumeProcesses", "input": { "shape_name": "ScalingProcessQuery", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or Amazon Resource Name (ARN) of the Auto Scaling group.\n

\n ", "required": true }, "ScalingProcesses": { "shape_name": "ProcessNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n The processes that you want to suspend or resume,\n which can include one or more of the following:\n

\n \n

\n To suspend all process types, omit this parameter.\n

\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n

\n Resumes Auto Scaling processes for an Auto Scaling group.\n For more information, see SuspendProcesses and ProcessType.\n

\n " }, "SetDesiredCapacity": { "name": "SetDesiredCapacity", "input": { "shape_name": "SetDesiredCapacityType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n The new capacity setting for the Auto Scaling group.\n

\n ", "required": true }, "HonorCooldown": { "shape_name": "HonorCooldown", "type": "boolean", "documentation": "\n

\n By default, SetDesiredCapacity overrides\n any cooldown period. Set to True if you want Auto Scaling to reject this\n request when the Auto Scaling group is in cooldown.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n

\n " } ], "documentation": "\n

\n Adjusts the desired size of the AutoScalingGroup\n by initiating scaling activities. When reducing\n the size of the group, it is not possible to define\n which Amazon EC2 instances will be terminated. This applies\n to any Auto Scaling decisions that might result\n in terminating instances.\n

\n

\n There are two common use cases for SetDesiredCapacity: \n one for users of the Auto Scaling triggering system, \n and another for developers who write their own triggering systems. \n Both use cases relate to the concept of cooldown.\n

\n

\n In the first case, if you use the Auto Scaling triggering system, \n SetDesiredCapacity changes the size \n of your Auto Scaling group without regard to the cooldown period. \n This could be useful, for example, if Auto Scaling did something \n unexpected for some reason. \n If your cooldown period is 10 minutes, Auto Scaling would normally reject \n requests to change the size of the group for that entire 10-minute \n period. The SetDesiredCapacity command allows you to \n circumvent this restriction and change the size of the group \n before the end of the cooldown period.\n

\n

\n In the second case, if you write your own triggering system, \n you can use SetDesiredCapacity to control the size\n of your Auto Scaling group. If you want the same cooldown \n functionality that Auto Scaling offers, you can configure \n SetDesiredCapacity to honor cooldown by setting the \n HonorCooldown parameter to true. \n

\n " }, "SetInstanceHealth": { "name": "SetInstanceHealth", "input": { "shape_name": "SetInstanceHealthQuery", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n

\n The identifier of the Amazon EC2 instance.\n

\n ", "required": true }, "HealthStatus": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The health status of the instance. \n \"Healthy\" means that the instance is healthy and should\n remain in service.\n \"Unhealthy\" means that the instance is unhealthy. Auto\n Scaling should terminate and replace it.\n

\n ", "required": true }, "ShouldRespectGracePeriod": { "shape_name": "ShouldRespectGracePeriod", "type": "boolean", "documentation": "\n

If True, this call should respect the grace period\n associated with the group.

\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n

\n Sets the health status of an instance. \n

\n " }, "SuspendProcesses": { "name": "SuspendProcesses", "input": { "shape_name": "ScalingProcessQuery", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name or Amazon Resource Name (ARN) of the Auto Scaling group.\n

\n ", "required": true }, "ScalingProcesses": { "shape_name": "ProcessNames", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "documentation": "\n

\n The processes that you want to suspend or resume,\n which can include one or more of the following:\n

\n \n

\n To suspend all process types, omit this parameter.\n

\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n

\n Suspends Auto Scaling processes for an Auto Scaling group.\n To suspend specific process types, specify them by name\n with the ScalingProcesses.member.N parameter.\n To suspend all process types, omit the ScalingProcesses.member.N\n parameter. \n

\n \n

\n Suspending either of the two primary process types,\n Launch or Terminate,\n can prevent other process types from functioning\n properly. For more information about processes\n and their dependencies, see ProcessType.\n

\n \n

\n To resume processes that have been suspended,\n use ResumeProcesses.\n

\n " }, "TerminateInstanceInAutoScalingGroup": { "name": "TerminateInstanceInAutoScalingGroup", "input": { "shape_name": "TerminateInstanceInAutoScalingGroupType", "type": "structure", "members": { "InstanceId": { "shape_name": "XmlStringMaxLen16", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 16, "documentation": "\n

\n The ID of the Amazon EC2 instance to be terminated.\n

\n ", "required": true }, "ShouldDecrementDesiredCapacity": { "shape_name": "ShouldDecrementDesiredCapacity", "type": "boolean", "documentation": "\n

\n Specifies whether (true) or not (false)\n terminating this instance should also decrement the\n size of the AutoScalingGroup.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ActivityType", "type": "structure", "members": { "Activity": { "shape_name": "Activity", "type": "structure", "members": { "ActivityId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Specifies the ID of the activity.\n

\n ", "required": true }, "AutoScalingGroupName": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "Description": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Contains a friendly, more verbose description of the scaling activity.\n

\n " }, "Cause": { "shape_name": "XmlStringMaxLen1023", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1023, "documentation": "\n

\n Contains the reason the activity was begun.\n

\n ", "required": true }, "StartTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Provides the start time of this activity.\n

\n ", "required": true }, "EndTime": { "shape_name": "TimestampType", "type": "timestamp", "documentation": "\n

\n Provides the end time of this activity.\n

\n " }, "StatusCode": { "shape_name": "ScalingActivityStatusCode", "type": "string", "enum": [ "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "Successful", "Failed", "Cancelled" ], "documentation": "\n

\n Contains the current status of the activity.\n

\n ", "required": true }, "StatusMessage": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n Contains a friendly, more verbose description of the activity status.\n

\n " }, "Progress": { "shape_name": "Progress", "type": "integer", "documentation": "\n

\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n

\n " }, "Details": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "documentation": "\n

\n Contains details of the scaling activity.\n

\n " } }, "documentation": "\n

\n A scaling Activity.\n

\n " } }, "documentation": "\n

\n The output for the TerminateInstanceInAutoScalingGroup action.\n

\n " }, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n

\n " } ], "documentation": "\n

\n Terminates the specified instance.\n Optionally, the desired group size can be adjusted.\n

\n \n This call simply registers a termination request.\n The termination of the instance cannot happen immediately.\n \n " }, "UpdateAutoScalingGroup": { "name": "UpdateAutoScalingGroup", "input": { "shape_name": "UpdateAutoScalingGroupType", "type": "structure", "members": { "AutoScalingGroupName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the Auto Scaling group.\n

\n ", "required": true }, "LaunchConfigurationName": { "shape_name": "ResourceName", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": "\n

\n The name of the launch configuration.\n

\n " }, "MinSize": { "shape_name": "AutoScalingGroupMinSize", "type": "integer", "documentation": "\n

\n The minimum size of the Auto Scaling group.\n

\n " }, "MaxSize": { "shape_name": "AutoScalingGroupMaxSize", "type": "integer", "documentation": "\n

\n The maximum size of the Auto Scaling group.\n

\n " }, "DesiredCapacity": { "shape_name": "AutoScalingGroupDesiredCapacity", "type": "integer", "documentation": "\n

\n The desired capacity for the Auto Scaling group.\n

\n " }, "DefaultCooldown": { "shape_name": "Cooldown", "type": "integer", "documentation": "\n

\n The amount of time, in seconds, after a scaling activity \n completes before any further trigger-related\n scaling activities can start.\n

\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "documentation": "\n

\n Availability Zones for the group.\n

\n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 32, "documentation": "\n

\n The service of interest for the health status check,\n either \"EC2\" for Amazon EC2 or \"ELB\" for Elastic Load Balancing.\n

\n " }, "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", "documentation": "\n

\n The length of time that Auto Scaling waits\n before checking an instance's health status.\n The grace period begins when an instance\n comes into service.\n

\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The name of the cluster placement group, if applicable. For\n more information, go to \n \n Using Cluster Instances\n in the Amazon EC2 User Guide.\n

\n " }, "VPCZoneIdentifier": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n The subnet identifier for the Amazon VPC connection, if applicable. You can specify several subnets in a \n comma-separated list. \n

\n

\n When you specify VPCZoneIdentifier with AvailabilityZones, ensure that the \n subnets' Availability Zones match the values you specify for AvailabilityZones.\n

\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", "type": "list", "members": { "shape_name": "XmlStringMaxLen1600", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1600, "documentation": null }, "documentation": "\n

\n A standalone termination policy or a list of termination policies used to select the instance to terminate. \n The policies are executed in the order that they are listed. \n

\n

\n For more information on creating a termination policy for your Auto Scaling group, go to \n Instance Termination Policy for Your Auto Scaling Group in the \n the Auto Scaling Developer Guide.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": null, "errors": [ { "shape_name": "ScalingActivityInProgressFault", "type": "structure", "members": { "message": { "shape_name": "XmlStringMaxLen255", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, "documentation": "\n

\n\n

\n " } }, "documentation": "\n

\n You cannot delete an Auto Scaling group\n while there are scaling activities in progress for that group.\n

\n " } ], "documentation": "\n

\n Updates the configuration for the specified AutoScalingGroup.\n

\n \n

\n To update an Auto Scaling group with a launch configuration\n that has the InstanceMonitoring flag\n set to False, you must first ensure that collection\n of group metrics is disabled. Otherwise, calls to \n UpdateAutoScalingGroup will fail.\n If you have previously enabled group metrics collection, \n you can disable collection of all group metrics\n by calling DisableMetricsCollection.\n \n

\n \n

\n The new settings are registered upon the completion of this call.\n Any launch configuration settings take effect on any triggers after\n this call returns.\n Triggers that are currently in progress aren't affected.\n

\n \n \n \n \n " } }, "xmlnamespace": "http://autoscaling.amazonaws.com/doc/2011-01-01/", "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://autoscaling.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "pagination": { "DescribeAutoScalingGroups": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AutoScalingGroups", "py_input_token": "next_token" }, "DescribeAutoScalingInstances": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AutoScalingInstances", "py_input_token": "next_token" }, "DescribeLaunchConfigurations": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "LaunchConfigurations", "py_input_token": "next_token" }, "DescribeNotificationConfigurations": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "NotificationConfigurations", "py_input_token": "next_token" }, "DescribePolicies": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "ScalingPolicies", "py_input_token": "next_token" }, "DescribeScalingActivities": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Activities", "py_input_token": "next_token" }, "DescribeScheduledActions": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "ScheduledUpdateGroupActions", "py_input_token": "next_token" }, "DescribeTags": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Tags", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/cloudformation.json0000644000175000017500000033126012254746566022175 0ustar takakitakaki{ "api_version": "2010-05-15", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "AWS CloudFormation", "endpoint_prefix": "cloudformation", "xmlnamespace": "http://cloudformation.amazonaws.com/doc/2010-05-15/", "documentation": "\n AWS CloudFormation\n

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly.\n AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling\n to build highly-reliable, highly scalable, cost effective applications without worrying about creating and\n configuring the underlying the AWS infrastructure.

\n

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all\n member resources of the stack together and manages all dependencies between the resources for you.

\n

For more information about this product, go to the CloudFormation Product Page.

\n

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a\n specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

\n You must call the AWS CloudFormation API as a regular IAM user. AWS CloudFormation does not support calling the API with\n an IAM\n role\n\n ", "operations": { "CancelUpdateStack": { "name": "CancelUpdateStack", "input": { "shape_name": "CancelUpdateStackInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n ", "required": true } }, "documentation": "\n

The input for CancelUpdateStack action.

\n " }, "output": null, "errors": [], "documentation": "\n

Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the\n update and revert to the previous stack configuration.

\n Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=CancelUpdateStack\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \n " }, "CreateStack": { "name": "CreateStack", "input": { "shape_name": "CreateStackInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with the stack. The name must be unique within your AWS account.

\n Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length\n of the name is 255 characters.\n ", "required": true }, "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\n

Structure containing the template body. (For more information, go to the AWS CloudFormation User\n Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

\n " }, "TemplateURL": { "shape_name": "TemplateURL", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User\n Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

\n ", "no_paramfile": true }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\n

The key associated with the parameter.

\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\n

The value associated with the parameter.

\n " } }, "documentation": "\n

The Parameter data type.

\n " }, "documentation": "\n

A list of Parameter structures that specify input parameters for the stack.

\n " }, "DisableRollback": { "shape_name": "DisableRollback", "type": "boolean", "documentation": "\n

Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.

\n

Default: false\n

\n " }, "TimeoutInMinutes": { "shape_name": "TimeoutMinutes", "type": "integer", "min_length": 1, "documentation": "\n

The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.

\n " }, "NotificationARNs": { "shape_name": "NotificationARNs", "type": "list", "members": { "shape_name": "NotificationARN", "type": "string", "documentation": null }, "max_length": 5, "documentation": "\n

The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic\n ARNs using the SNS console or your Command Line Interface\n (CLI).

\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\n

The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you\n must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an\n InsufficientCapabilities error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

\n " }, "OnFailure": { "shape_name": "OnFailure", "type": "string", "enum": [ "DO_NOTHING", "ROLLBACK", "DELETE" ], "documentation": "\n

Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or\n DELETE. You can specify either OnFailure or DisableRollback, but not both.

\n

Default: ROLLBACK

\n " }, "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\n

Structure containing the stack policy body. (For more information, go to the \n AWS CloudFormation User Guide.)

\n

If you pass StackPolicyBody and StackPolicyURL, only\n StackPolicyBody is used.

\n " }, "StackPolicyURL": { "shape_name": "StackPolicyURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\n

Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass StackPolicyBody and StackPolicyURL, only\n StackPolicyBody is used.

\n ", "no_paramfile": true }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "TagKey", "type": "string", "documentation": "\n

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.\n Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

\n " }, "Value": { "shape_name": "TagValue", "type": "string", "documentation": "\n

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a\n tag value.

\n " } }, "documentation": "\n

The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a\n key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation\n stack.

\n " }, "documentation": "\n

A set of user-defined Tags to associate with this stack, represented by key/value pairs. Tags\n defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of\n 10 tags can be specified.

\n " } }, "documentation": "\n

The input for CreateStack action.

\n " }, "output": { "shape_name": "CreateStackOutput", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique identifier of the stack.

\n " } }, "documentation": "\n

The output for a CreateStack action.

\n " }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

Quota for the resource has already been reached.

\n " }, { "shape_name": "AlreadyExistsException", "type": "structure", "members": {}, "documentation": "\n

Resource with the name requested already exists.

\n " }, { "shape_name": "InsufficientCapabilitiesException", "type": "structure", "members": {}, "documentation": "\n

The template contains resources with capabilities that were not specified in the Capabilities parameter.

\n " } ], "documentation": "\n

Creates a stack as specified in the template. After the call completes successfully, the stack creation\n starts. You can check the status of the stack via the DescribeStacks API.

\n Currently, the limit for stacks is 20 stacks per account per region. \n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=CreateStack\n &StackName=MyStack\n &TemplateBody=[Template Document]\n &NotificationARNs.member.1=arn:aws:sns:us-east-1:1234567890:my-topic\n &Parameters.member.1.ParameterKey=AvailabilityZone\n &Parameters.member.1.ParameterValue=us-east-1a\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n\n \n " }, "DeleteStack": { "name": "DeleteStack", "input": { "shape_name": "DeleteStackInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n ", "required": true } }, "documentation": "\n

The input for DeleteStack action.

\n " }, "output": null, "errors": [], "documentation": "\n

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not\n show up in the DescribeStacks API if the deletion has been completed successfully.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DeleteStack\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \n " }, "DescribeStackEvents": { "name": "DescribeStackEvents", "input": { "shape_name": "DescribeStackEventsInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n

Default: There is no default value.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of events, if there is one.

\n

Default: There is no default value.

\n " } }, "documentation": "\n

The input for DescribeStackEvents action.

\n " }, "output": { "shape_name": "DescribeStackEventsOutput", "type": "structure", "members": { "StackEvents": { "shape_name": "StackEvents", "type": "list", "members": { "shape_name": "StackEvent", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

The unique ID name of the instance of the stack.

\n ", "required": true }, "EventId": { "shape_name": "EventId", "type": "string", "documentation": "\n

The unique ID of this event.

\n ", "required": true }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with a stack.

\n ", "required": true }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource specified in the template.

\n " }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\n

The name or unique identifier associated with the physical instance of the resource.

\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\n

Type of the resource. (For more information, go to the AWS CloudFormation User\n Guide.)

\n " }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

Time the status was updated.

\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\n

Current status of the resource.

\n " }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\n

Success/failure message associated with the resource.

\n " }, "ResourceProperties": { "shape_name": "ResourceProperties", "type": "string", "documentation": "\n

BLOB of the properties used to create the resource.

\n " } }, "documentation": "\n

The StackEvent data type.

\n " }, "documentation": "\n

A list of StackEvents structures.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of events, if there is one.

\n " } }, "documentation": "\n

The output for a DescribeStackEvents action.

\n " }, "errors": [], "documentation": "\n

Returns all stack related events for a specified stack. For more information about a stack's event history, go to the AWS CloudFormation User\n Guide.

\n Events are returned, even if the stack never existed or has been successfully deleted.\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackEvents\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n Event-1-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyStack\n MyStack_One\n AWS::CloudFormation::Stack\n 2010-07-27T22:26:28Z\n CREATE_IN_PROGRESS\n User initiated\n \n \n Event-2-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::SecurityGroup\n 2010-07-27T22:27:28Z\n CREATE_IN_PROGRESS\n {\"GroupDescription\":...}\n \n \n Event-3-Id\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MySG1\n MyStack_SG1\n AWS:: SecurityGroup\n 2010-07-27T22:28:28Z\n CREATE_COMPLETE\n \n \n\n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackEvents", "py_input_token": "next_token" } }, "DescribeStackResource": { "name": "DescribeStackResource", "input": { "shape_name": "DescribeStackResourceInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n

Default: There is no default value.

\n ", "required": true }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource as specified in the template.

\n

Default: There is no default value.

\n ", "required": true } }, "documentation": "\n

The input for DescribeStackResource action.

\n " }, "output": { "shape_name": "DescribeStackResourceOutput", "type": "structure", "members": { "StackResourceDetail": { "shape_name": "StackResourceDetail", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with the stack.

\n " }, "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique identifier of the stack.

\n " }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource specified in the template.

\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\n

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\n

Type of the resource. (For more information, go to the AWS CloudFormation User\n Guide.)

\n ", "required": true }, "LastUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

Time the status was updated.

\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\n

Current status of the resource.

\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\n

Success/failure message associated with the resource.

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

User defined description associated with the resource.

\n " }, "Metadata": { "shape_name": "Metadata", "type": "string", "documentation": "\n

The JSON format content of the Metadata attribute declared for the resource. For more\n information, see Metadata Attribute in the AWS CloudFormation User Guide.

\n " } }, "documentation": "\n

A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.

\n " } }, "documentation": "\n

The output for a DescribeStackResource action.

\n " }, "errors": [], "documentation": "\n

Returns a description of the specified resource in the specified stack.

\n

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackResource\n &StackName=MyStack\n &LogicalResourceId=MyDBInstance\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-07-08T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::RDS::DBInstance\n 2011-07-07T22:27:28Z\n CREATE_COMPLETE\n \n \n\n \n\n " }, "DescribeStackResources": { "name": "DescribeStackResources", "input": { "shape_name": "DescribeStackResourcesInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n

Required: Conditional. If you do not specify StackName, you must specify\n PhysicalResourceId.

\n

Default: There is no default value.

\n " }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource as specified in the template.

\n

Default: There is no default value.

\n " }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\n

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

\n

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to\n DescribeStackResources to find which stack the instance belongs to and what other resources are\n part of the stack.

\n

Required: Conditional. If you do not specify PhysicalResourceId, you must specify\n StackName.

\n

Default: There is no default value.

\n " } }, "documentation": "\n

The input for DescribeStackResources action.

\n " }, "output": { "shape_name": "DescribeStackResourcesOutput", "type": "structure", "members": { "StackResources": { "shape_name": "StackResources", "type": "list", "members": { "shape_name": "StackResource", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with the stack.

\n " }, "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique identifier of the stack.

\n " }, "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource specified in the template.

\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\n

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS\n CloudFormation.

\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\n

Type of the resource. (For more information, go to the AWS CloudFormation User\n Guide.)

\n ", "required": true }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

Time the status was updated.

\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\n

Current status of the resource.

\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\n

Success/failure message associated with the resource.

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

User defined description associated with the resource.

\n " } }, "documentation": "\n

The StackResource data type.

\n " }, "documentation": "\n

A list of StackResource structures.

\n " } }, "documentation": "\n

The output for a DescribeStackResources action.

\n " }, "errors": [], "documentation": "\n

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all\n the associated resources that are part of the stack are returned. If PhysicalResourceId is\n specified, the associated resources of the stack that the resource belongs to are returned.

\n\n Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.\n\n

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after\n the stack has been deleted.

\n\n

You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about\n resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

\n\n A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStackResources\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyDBInstance\n MyStack_DB1\n AWS::DBInstance\n 2010-07-27T22:27:28Z\n CREATE_COMPLETE\n \n \n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n MyStack\n MyAutoScalingGroup\n MyStack_ASG1\n AWS::AutoScalingGroup\n 2010-07-27T22:28:28Z\n CREATE_IN_PROGRESS\n \n \n\n \n\n " }, "DescribeStacks": { "name": "DescribeStacks", "input": { "shape_name": "DescribeStacksInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack.

\n

Default: There is no default value.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null } }, "documentation": "\n

The input for DescribeStacks action.

\n " }, "output": { "shape_name": "DescribeStacksOutput", "type": "structure", "members": { "Stacks": { "shape_name": "Stacks", "type": "list", "members": { "shape_name": "Stack", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique identifier of the stack.

\n " }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with the stack.

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

User defined description associated with the stack.

\n " }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\n

The key associated with the parameter.

\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\n

The value associated with the parameter.

\n " } }, "documentation": "\n

The Parameter data type.

\n " }, "documentation": "\n

A list of Parameter structures.

\n " }, "CreationTime": { "shape_name": "CreationTime", "type": "timestamp", "documentation": "\n

Time at which the stack was created.

\n ", "required": true }, "LastUpdatedTime": { "shape_name": "LastUpdatedTime", "type": "timestamp", "documentation": "\n

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

\n " }, "StackStatus": { "shape_name": "StackStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE" ], "documentation": "\n

Current status of the stack.

\n ", "required": true }, "StackStatusReason": { "shape_name": "StackStatusReason", "type": "string", "documentation": "\n

Success/failure message associated with the stack status.

\n " }, "DisableRollback": { "shape_name": "DisableRollback", "type": "boolean", "documentation": "\n

Boolean to enable or disable rollback on stack creation failures:

\n

\n

\n

\n " }, "NotificationARNs": { "shape_name": "NotificationARNs", "type": "list", "members": { "shape_name": "NotificationARN", "type": "string", "documentation": null }, "max_length": 5, "documentation": "\n

SNS topic ARNs to which stack related events are published.

\n " }, "TimeoutInMinutes": { "shape_name": "TimeoutMinutes", "type": "integer", "min_length": 1, "documentation": "\n

The amount of time within which stack creation should complete.

\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\n

The capabilities allowed in the stack.

\n " }, "Outputs": { "shape_name": "Outputs", "type": "list", "members": { "shape_name": "Output", "type": "structure", "members": { "OutputKey": { "shape_name": "OutputKey", "type": "string", "documentation": "\n

The key associated with the output.

\n " }, "OutputValue": { "shape_name": "OutputValue", "type": "string", "documentation": "\n

The value associated with the output.

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

User defined description associated with the output.

\n " } }, "documentation": "\n

The Output data type.

\n " }, "documentation": "\n

A list of output structures.

\n " }, "Tags": { "shape_name": "Tags", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "TagKey", "type": "string", "documentation": "\n

Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.\n Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.

\n " }, "Value": { "shape_name": "TagValue", "type": "string", "documentation": "\n

Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a\n tag value.

\n " } }, "documentation": "\n

The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a\n key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation\n stack.

\n " }, "documentation": "\n

A list of Tags that specify cost allocation information for the stack.

\n " } }, "documentation": "\n

The Stack data type.

\n " }, "documentation": "\n

A list of stack structures.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null } }, "documentation": "\n

The output for a DescribeStacks action.

\n " }, "errors": [], "documentation": "\n

Returns the description for the specified stack; if no stack name was specified, then it returns the\n description for all the stacks created.

\n \n\n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=DescribeStacks\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \n \n MyStack\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n 2010-07-27T22:28:28Z\n CREATE_COMPLETE\n false\n \n \n StartPage\n http://my-load-balancer.amazonaws.com:80/index.html\n \n \n \n \n\n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Stacks", "py_input_token": "next_token" } }, "EstimateTemplateCost": { "name": "EstimateTemplateCost", "input": { "shape_name": "EstimateTemplateCostInput", "type": "structure", "members": { "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\n

Structure containing the template body. (For more information, go to the AWS CloudFormation User\n Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

\n " }, "TemplateURL": { "shape_name": "TemplateURL", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to the AWS CloudFormation User\n Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

\n ", "no_paramfile": true }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\n

The key associated with the parameter.

\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\n

The value associated with the parameter.

\n " } }, "documentation": "\n

The Parameter data type.

\n " }, "documentation": "\n

A list of Parameter structures that specify input parameters.

\n " } }, "documentation": " " }, "output": { "shape_name": "EstimateTemplateCostOutput", "type": "structure", "members": { "Url": { "shape_name": "Url", "type": "string", "documentation": "\n

An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the\n template.

\n " } }, "documentation": "\n

The output for a EstimateTemplateCost action.

\n " }, "errors": [], "documentation": "\n

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with\n a query string that describes the resources required to run the template.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=EstimateTemplateCost\n &TemplateURL= https://s3.amazonaws.com/cloudformation-samples-us-east-1/Drupal_Simple.template\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-12-04T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n http://calculator.s3.amazonaws.com/calc5.html?key=cf-2e351785-e821-450c-9d58-625e1e1ebfb6\n\n \n " }, "GetStackPolicy": { "name": "GetStackPolicy", "input": { "shape_name": "GetStackPolicyInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or stack ID that is associated with the stack whose policy you want to get.

\n ", "required": true } }, "documentation": "\n

The input for the GetStackPolicy action.

\n " }, "output": { "shape_name": "GetStackPolicyOutput", "type": "structure", "members": { "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\n

Structure containing the stack policy body. (For more information, go to the \n AWS CloudFormation User Guide.)

\n " } }, "documentation": "\n

The output for the GetStackPolicy action.

\n " }, "errors": [], "documentation": "\n

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=GetStackPolicy\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n\n \"{\n \"Statement\" : [\n {\n \"Effect\" : \"Deny\",\n \"Action\" : \"Update*\",\n \"Resource\" : \"LogicalResourceId/ProductionDatabase\"\n },\n {\n \"Effect\" : \"Allow\",\n \"Action\" : \"Update:*\",\n \"Resource\" : \"*\"\n }\n ]\n }\n\n \n " }, "GetTemplate": { "name": "GetTemplate", "input": { "shape_name": "GetTemplateInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

\n ", "required": true } }, "documentation": "\n

The input for a GetTemplate action.

\n " }, "output": { "shape_name": "GetTemplateOutput", "type": "structure", "members": { "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\n

Structure containing the template body. (For more information, go to the AWS CloudFormation User\n Guide.)

\n " } }, "documentation": "\n

The output for GetTemplate action.

\n " }, "errors": [], "documentation": "\n

Returns the template body for a specified stack. You can get the template for running or deleted\n stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

\n If the template does not exist, a ValidationError is returned. \n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=GetTemplate\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \"{\n \"AWSTemplateFormatVersion\" : \"2010-09-09\",\n \"Description\" : \"Simple example\",\n \"Resources\" : {\n \"MySQS\" : {\n \"Type\" : \"AWS::SQS::Queue\",\n \"Properties\" : {\n }\n }\n }\n}\n\n \n " }, "ListStackResources": { "name": "ListStackResources", "input": { "shape_name": "ListStackResourcesInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or the unique identifier associated with the stack, which are not always interchangeable:

\n \n

Default: There is no default value.

\n ", "required": true }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of stack resource summaries, if there is one.

\n

Default: There is no default value.

\n " } }, "documentation": "\n

The input for ListStackResource action.

\n " }, "output": { "shape_name": "ListStackResourcesOutput", "type": "structure", "members": { "StackResourceSummaries": { "shape_name": "StackResourceSummaries", "type": "list", "members": { "shape_name": "StackResourceSummary", "type": "structure", "members": { "LogicalResourceId": { "shape_name": "LogicalResourceId", "type": "string", "documentation": "\n

The logical name of the resource specified in the template.

\n ", "required": true }, "PhysicalResourceId": { "shape_name": "PhysicalResourceId", "type": "string", "documentation": "\n

The name or unique identifier that corresponds to a physical instance ID of the resource.

\n " }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "documentation": "\n

Type of the resource. (For more information, go to the AWS CloudFormation User\n Guide.)

\n ", "required": true }, "LastUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

Time the status was updated.

\n ", "required": true }, "ResourceStatus": { "shape_name": "ResourceStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ], "documentation": "\n

Current status of the resource.

\n ", "required": true }, "ResourceStatusReason": { "shape_name": "ResourceStatusReason", "type": "string", "documentation": "\n

Success/failure message associated with the resource.

\n " } }, "documentation": "\n

Contains high-level information about the specified stack resource.

\n " }, "documentation": "\n

A list of StackResourceSummary structures.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of events, if there is one.

\n " } }, "documentation": "\n

The output for a ListStackResources action.

\n " }, "errors": [], "documentation": "\n

Returns descriptions of all resources of the specified stack.

\n

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ListStackResources\n &StackName=MyStack\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2011-07-08T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n \n CREATE_COMPLETE\n DBSecurityGroup\n 2011-06-21T20:15:58Z\n gmarcteststack-dbsecuritygroup-1s5m0ez5lkk6w\n AWS::RDS::DBSecurityGroup\n \n \n CREATE_COMPLETE\n SampleDB\n 2011-06-21T20:25:57Z\n MyStack-sampledb-ycwhk1v830lx\n AWS::RDS::DBInstance\n \n \n CREATE_COMPLETE\n SampleApplication\n 2011-06-21T20:26:12Z\n MyStack-SampleApplication-1MKNASYR3RBQL\n AWS::ElasticBeanstalk::Application\n \n \n CREATE_COMPLETE\n SampleEnvironment\n 2011-06-21T20:28:48Z\n myst-Samp-1AGU6ERZX6M3Q\n AWS::ElasticBeanstalk::Environment\n \n \n CREATE_COMPLETE\n AlarmTopic\n 2011-06-21T20:29:06Z\n arn:aws:sns:us-east-1:803981987763:MyStack-AlarmTopic-SW4IQELG7RPJ\n AWS::SNS::Topic\n \n \n CREATE_COMPLETE\n CPUAlarmHigh\n 2011-06-21T20:29:23Z\n MyStack-CPUAlarmHigh-POBWQPDJA81F\n AWS::CloudWatch::Alarm\n \n \n \n \n 2d06e36c-ac1d-11e0-a958-f9382b6eb86b\n \n\n\n \n\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackResourceSummaries", "py_input_token": "next_token" } }, "ListStacks": { "name": "ListStacks", "input": { "shape_name": "ListStacksInput", "type": "structure", "members": { "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of stacks, if there is one.

\n

Default: There is no default value.

\n " }, "StackStatusFilter": { "shape_name": "StackStatusFilter", "type": "list", "members": { "shape_name": "StackStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE" ], "documentation": null }, "documentation": "\n

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the\n Stack data type.

\n " } }, "documentation": "\n

The input for ListStacks action.

\n " }, "output": { "shape_name": "ListStacksOutput", "type": "structure", "members": { "StackSummaries": { "shape_name": "StackSummaries", "type": "list", "members": { "shape_name": "StackSummary", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique stack identifier.

\n " }, "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name associated with the stack.

\n ", "required": true }, "TemplateDescription": { "shape_name": "TemplateDescription", "type": "string", "documentation": "\n

The template description of the template used to create the stack.

\n " }, "CreationTime": { "shape_name": "CreationTime", "type": "timestamp", "documentation": "\n

The time the stack was created.

\n ", "required": true }, "LastUpdatedTime": { "shape_name": "LastUpdatedTime", "type": "timestamp", "documentation": "\n

The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.

\n " }, "DeletionTime": { "shape_name": "DeletionTime", "type": "timestamp", "documentation": "\n

The time the stack was deleted.

\n " }, "StackStatus": { "shape_name": "StackStatus", "type": "string", "enum": [ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "ROLLBACK_IN_PROGRESS", "ROLLBACK_FAILED", "ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_FAILED", "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE" ], "documentation": "\n

The current status of the stack.

\n ", "required": true }, "StackStatusReason": { "shape_name": "StackStatusReason", "type": "string", "documentation": "\n

Success/Failure message associated with the stack status.

\n " } }, "documentation": "\n

The StackSummary Data Type

\n " }, "documentation": "\n

A list of StackSummary structures containing information about the specified stacks.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

String that identifies the start of the next list of stacks, if there is one.

\n " } }, "documentation": "\n

The output for ListStacks action.

\n " }, "errors": [], "documentation": "\n

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no\n StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and\n stacks that have been deleted).

\n \n\n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ListStacks\n &StackStatusFilter.member.1=CREATE_IN_PROGRESS\n &StackStatusFilter.member.2=DELETE_COMPLETE\n &Version=2010-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n \n \n \n \n \n arn:aws:cloudformation:us-east-1:1234567:stack/TestCreate1/aaaaa\n \n CREATE_IN_PROGRESS\n vpc1\n 2011-05-23T15:47:44Z\n \n Creates one EC2 instance and a load balancer.\n \n \n \n \n arn:aws:cloudformation:us-east-1:1234567:stack/TestDelete2/bbbbb\n \n DELETE_COMPLETE\n 2011-03-10T16:20:51Z\n WP1\n 2011-03-05T19:57:58Z\n \n A simple basic Cloudformation Template.\n \n \n \n \n\n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackSummaries", "py_input_token": "next_token" } }, "SetStackPolicy": { "name": "SetStackPolicy", "input": { "shape_name": "SetStackPolicyInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or stack ID that you want to associate a policy with.

\n ", "required": true }, "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\n

Structure containing the stack policy body. (For more information, go to the \n AWS CloudFormation User Guide.)

\n

You must pass StackPolicyBody or StackPolicyURL. If both are passed, only\n StackPolicyBody is used.

\n " }, "StackPolicyURL": { "shape_name": "StackPolicyURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\n

Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You must pass StackPolicyBody or StackPolicyURL. If both are passed, only\n StackPolicyBody is used.

\n " } }, "documentation": "\n

The input for the SetStackPolicy action.

\n " }, "output": null, "errors": [], "documentation": "\n

Sets a stack policy for a specified stack.

\n " }, "UpdateStack": { "name": "UpdateStack", "input": { "shape_name": "UpdateStackInput", "type": "structure", "members": { "StackName": { "shape_name": "StackName", "type": "string", "documentation": "\n

The name or stack ID of the stack to update.

\n Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum\n length of the name is 255 characters. \n ", "required": true }, "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\n

Structure containing the template body. (For more information, go to the AWS CloudFormation User\n Guide.)

\n

Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.

\n " }, "TemplateURL": { "shape_name": "TemplateURL", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

Location of file containing the template body. The URL must point to a template located in an S3 bucket in the\n same region as the stack. For more information, go to the AWS CloudFormation User\n Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

\n ", "no_paramfile": true }, "StackPolicyDuringUpdateBody": { "shape_name": "StackPolicyDuringUpdateBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\n

Structure containing the temporary overriding stack policy body. If you pass StackPolicyDuringUpdateBody and StackPolicyDuringUpdateURL, only\n StackPolicyDuringUpdateBody is used.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that associated with the stack will be used.

\n " }, "StackPolicyDuringUpdateURL": { "shape_name": "StackPolicyDuringUpdateURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\n

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass StackPolicyDuringUpdateBody and StackPolicyDuringUpdateURL, only\n StackPolicyDuringUpdateBody is used.

\n

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

\n " }, "Parameters": { "shape_name": "Parameters", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\n

The key associated with the parameter.

\n " }, "ParameterValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\n

The value associated with the parameter.

\n " } }, "documentation": "\n

The Parameter data type.

\n " }, "documentation": "\n

A list of Parameter structures that specify input parameters for the stack.

\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\n

The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must\n specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities\n error. IAM resources are the following: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and AWS::IAM::UserToGroupAddition.

\n " }, "StackPolicyBody": { "shape_name": "StackPolicyBody", "type": "string", "min_length": 1, "max_length": 16384, "documentation": "\n

Structure containing the updated stack policy body. If you pass StackPolicyBody and StackPolicyURL, only\n StackPolicyBody is used.

\n

If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

\n " }, "StackPolicyURL": { "shape_name": "StackPolicyURL", "type": "string", "min_length": 1, "max_length": 1350, "documentation": "\n

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. If you pass StackPolicyBody and StackPolicyURL, only\n StackPolicyBody is used.

\n

If you want to update a stack policy during a stack update, specify an updated stack policy. For example, you can include an updated stack policy to protect a new resource created in the stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

\n ", "no_paramfile": true } }, "documentation": "\n

The input for UpdateStack action.

\n " }, "output": { "shape_name": "UpdateStackOutput", "type": "structure", "members": { "StackId": { "shape_name": "StackId", "type": "string", "documentation": "\n

Unique identifier of the stack.

\n " } }, "documentation": "\n

The output for a UpdateStack action.

\n " }, "errors": [ { "shape_name": "InsufficientCapabilitiesException", "type": "structure", "members": {}, "documentation": "\n

The template contains resources with capabilities that were not specified in the Capabilities parameter.

\n " } ], "documentation": "\n

Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack via the DescribeStacks action.

\n

\n

Note: You cannot update AWS::S3::Bucket\n resources, for example, to add or modify tags.

\n

\n

To get a copy of the template for an existing stack, you can use the GetTemplate action.

\n

Tags that were associated with this stack during creation time will still be associated with the stack after an\n UpdateStack operation.

\n

For more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=UpdateStack\n &StackName=MyStack\n &TemplateBody=[Template Document]\n &Parameters.member.1.ParameterKey=AvailabilityZone\n &Parameters.member.1.ParameterValue=us-east-1a\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n arn:aws:cloudformation:us-east-1:123456789:stack/MyStack/aaf549a0-a413-11df-adb3-5081b3858e83\n\n \n " }, "ValidateTemplate": { "name": "ValidateTemplate", "input": { "shape_name": "ValidateTemplateInput", "type": "structure", "members": { "TemplateBody": { "shape_name": "TemplateBody", "type": "string", "min_length": 1, "documentation": "\n

String containing the template body. (For more information, go to the AWS CloudFormation User\n Guide.)

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

\n " }, "TemplateURL": { "shape_name": "TemplateURL", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes)\n located in an S3 bucket in the same region as the stack. For more information, go to the AWS CloudFormation User\n Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.

\n ", "no_paramfile": true } }, "documentation": "\n

The input for ValidateTemplate action.

\n " }, "output": { "shape_name": "ValidateTemplateOutput", "type": "structure", "members": { "Parameters": { "shape_name": "TemplateParameters", "type": "list", "members": { "shape_name": "TemplateParameter", "type": "structure", "members": { "ParameterKey": { "shape_name": "ParameterKey", "type": "string", "documentation": "\n

The name associated with the parameter.

\n " }, "DefaultValue": { "shape_name": "ParameterValue", "type": "string", "documentation": "\n

The default value associated with the parameter.

\n " }, "NoEcho": { "shape_name": "NoEcho", "type": "boolean", "documentation": "\n

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

User defined description associated with the parameter.

\n " } }, "documentation": "\n

The TemplateParameter data type.

\n " }, "documentation": "\n

A list of TemplateParameter structures.

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

The description found within the template.

\n " }, "Capabilities": { "shape_name": "Capabilities", "type": "list", "members": { "shape_name": "Capability", "type": "string", "enum": [ "CAPABILITY_IAM" ], "documentation": null }, "documentation": "\n

The capabilities found within the template. Currently, CAPABILITY_IAM is the only capability detected. If\n your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those actions return an\n InsufficientCapabilities error.

\n " }, "CapabilitiesReason": { "shape_name": "CapabilitiesReason", "type": "string", "documentation": "\n

The capabilities reason found within the template.

\n " } }, "documentation": "\n

The output for ValidateTemplate action.

\n " }, "errors": [], "documentation": "\n

Validates a specified template.

\n\n \n \nhttps://cloudformation.us-east-1.amazonaws.com/\n ?Action=ValidateTemplate\n &TemplateBody=http://myTemplateRepository/TemplateOne.template\n &Version=2010-05-15\n &SignatureVersion=2\n &Timestamp=2010-07-27T22%3A26%3A28.000Z\n &AWSAccessKeyId=[AWS Access KeyID]\n &Signature=[Signature]\n\n \n\n \n \n \n \n false\n InstanceType\n Type of instance to launch\n m1.small\n \n \n false\n WebServerPort\n The TCP port for the Web Server\n 8888\n \n \n false\n KeyName\n Name of an existing EC2 KeyPair to enable SSH access into the server\n \n \n \n \n 0be7b6e8-e4a0-11e0-a5bd-9f8d5a7dbc91\n \n\n\n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://cloudformation.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "DescribeStackEvents": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackEvents", "py_input_token": "next_token" }, "DescribeStacks": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Stacks", "py_input_token": "next_token" }, "ListStackResources": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackResourceSummaries", "py_input_token": "next_token" }, "ListStacks": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackSummaries", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/cloudfront.json0000644000175000017500000256555212254746566021346 0ustar takakitakaki{ "api_version": "2013-11-11", "type": "rest-xml", "signature_version": "v4", "service_full_name": "Amazon CloudFront", "service_abbreviation": "CloudFront", "global_endpoint": "cloudfront.amazonaws.com", "endpoint_prefix": "cloudfront", "xmlnamespace": "http://cloudfront.amazonaws.com/doc/2013-11-11/", "documentation": "\n ", "operations": { "CreateCloudFrontOriginAccessIdentity": { "name": "CreateCloudFrontOriginAccessIdentity2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront", "method": "POST", "response_code": 201 }, "input": { "shape_name": "CreateCloudFrontOriginAccessIdentityRequest", "type": "structure", "members": { "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The origin access identity's configuration information.\n ", "required": true, "payload": true } }, "documentation": "\n The request to create a new origin access identity.\n " }, "output": { "shape_name": "CreateCloudFrontOriginAccessIdentityResult", "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "shape_name": "CloudFrontOriginAccessIdentity", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The ID for the origin access identity. For example: E74FTE3AJFJ256A.\n ", "required": true }, "S3CanonicalUserId": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.\n ", "required": true }, "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The current configuration information for the identity.\n " } }, "documentation": "\n The origin access identity's information.\n ", "payload": true }, "Location": { "shape_name": "string", "type": "string", "documentation": "\n The fully qualified URI of the new origin access identity just created.\n For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.\n ", "location": "header", "location_name": "Location" }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the origin access identity created.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "CloudFrontOriginAccessIdentityAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "TooManyCloudFrontOriginAccessIdentities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Processing your request would cause you to exceed the maximum number of origin access identities allowed.\n " }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " } ], "documentation": "\n Create a new origin access identity.\n " }, "CreateDistribution": { "name": "CreateDistribution2013_11_11", "http": { "uri": "/2013-11-11/distribution", "method": "POST", "response_code": 201 }, "input": { "shape_name": "CreateDistributionRequest", "type": "structure", "members": { "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The distribution's configuration information.\n ", "required": true, "payload": true } }, "documentation": "\n The request to create a new distribution.\n " }, "output": { "shape_name": "CreateDistributionResult", "type": "structure", "members": { "Distribution": { "shape_name": "Distribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the distribution. For example: EDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n This response element indicates the current status of the distribution.\n When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n ", "required": true }, "InProgressInvalidationBatches": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of invalidation batches currently in progress.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The current configuration information for the distribution.\n ", "required": true } }, "documentation": "\n The distribution's information.\n ", "payload": true }, "Location": { "shape_name": "string", "type": "string", "documentation": "\n The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.\n ", "location": "header", "location_name": "Location" }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the distribution created.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "CNAMEAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "DistributionAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The caller reference you attempted to create the distribution with is associated with another distribution.\n " }, { "shape_name": "InvalidOrigin", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.\n " }, { "shape_name": "InvalidOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The origin access identity is not valid or doesn't exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "TooManyTrustedSigners", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more trusted signers than are allowed per distribution.\n " }, { "shape_name": "TrustedSignerDoesNotExist", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n One or more of your trusted signers do not exist.\n " }, { "shape_name": "InvalidViewerCertificate", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "TooManyDistributionCNAMEs", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more CNAMEs than are allowed per distribution.\n " }, { "shape_name": "TooManyDistributions", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Processing your request would cause you to exceed the maximum number of distributions allowed.\n " }, { "shape_name": "InvalidDefaultRootObject", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The default root object file name is too big or contains an invalid character.\n " }, { "shape_name": "InvalidRelativePath", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The relative path is too big, is not URL-encoded, or\n does not begin with a slash (/).\n " }, { "shape_name": "InvalidErrorCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidResponseCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InvalidRequiredProtocol", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.\n " }, { "shape_name": "NoSuchOrigin", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n No origin exists with the specified Origin Id.\n " }, { "shape_name": "TooManyOrigins", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore origins for the distribution. \n " }, { "shape_name": "TooManyCacheBehaviors", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore cache behaviors for the distribution.\n " }, { "shape_name": "TooManyCookieNamesInWhiteList", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more cookie names in the whitelist than are allowed per cache behavior.\n " }, { "shape_name": "InvalidForwardCookies", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains forward cookies option which doesn't match with the expectation for the whitelisted\n list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names\n is missing when expected.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " }, { "shape_name": "TooManyCertificates", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore custom ssl certificates.\n " }, { "shape_name": "InvalidLocationCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidGeoRestrictionParameter", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n Create a new distribution.\n " }, "CreateInvalidation": { "name": "CreateInvalidation2013_11_11", "http": { "uri": "/2013-11-11/distribution/{DistributionId}/invalidation", "method": "POST", "response_code": 201 }, "input": { "shape_name": "CreateInvalidationRequest", "type": "structure", "members": { "DistributionId": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "required": true, "location": "uri" }, "InvalidationBatch": { "shape_name": "InvalidationBatch", "type": "structure", "members": { "Paths": { "shape_name": "Paths", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of objects that you want to invalidate.\n ", "required": true }, "Items": { "shape_name": "PathList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Path" }, "documentation": "\n A complex type that contains a list of the objects that you want to\n invalidate.\n " } }, "documentation": "\n The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags.\n If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.\n ", "required": true }, "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique name that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the Path object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request,\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request,\n CloudFront returns an InvalidationBatchAlreadyExists error.\n ", "required": true } }, "documentation": "\n The batch information for the invalidation.\n ", "required": true, "payload": true } }, "documentation": "\n The request to create an invalidation.\n " }, "output": { "shape_name": "CreateInvalidationResult", "type": "structure", "members": { "Location": { "shape_name": "string", "type": "string", "documentation": "\n The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.\n ", "location": "header", "location_name": "Location" }, "Invalidation": { "shape_name": "Invalidation", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the invalidation request. For example: IDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The status of the invalidation request. When the invalidation batch is finished, the status is Completed.\n ", "required": true }, "CreateTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the invalidation request was first made.\n ", "required": true }, "InvalidationBatch": { "shape_name": "InvalidationBatch", "type": "structure", "members": { "Paths": { "shape_name": "Paths", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of objects that you want to invalidate.\n ", "required": true }, "Items": { "shape_name": "PathList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Path" }, "documentation": "\n A complex type that contains a list of the objects that you want to\n invalidate.\n " } }, "documentation": "\n The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags.\n If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.\n ", "required": true }, "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique name that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the Path object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request,\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request,\n CloudFront returns an InvalidationBatchAlreadyExists error.\n ", "required": true } }, "documentation": "\n The current invalidation information for the batch request.\n ", "required": true } }, "documentation": "\n The invalidation's information.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "BatchTooLarge", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "TooManyInvalidationsInProgress", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " } ], "documentation": "\n Create a new invalidation.\n " }, "CreateStreamingDistribution": { "name": "CreateStreamingDistribution2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution", "method": "POST", "response_code": 201 }, "input": { "shape_name": "CreateStreamingDistributionRequest", "type": "structure", "members": { "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The streaming distribution's configuration information.\n ", "required": true, "payload": true } }, "documentation": "\n The request to create a new streaming distribution.\n " }, "output": { "shape_name": "CreateStreamingDistributionResult", "type": "structure", "members": { "StreamingDistribution": { "shape_name": "StreamingDistribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n " }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The current configuration information for the streaming distribution.\n ", "required": true } }, "documentation": "\n The streaming distribution's information.\n ", "payload": true }, "Location": { "shape_name": "string", "type": "string", "documentation": "\n The fully qualified URI of the new streaming distribution resource just created.\n For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.\n ", "location": "header", "location_name": "Location" }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the streaming distribution created.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "CNAMEAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "StreamingDistributionAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidOrigin", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.\n " }, { "shape_name": "InvalidOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The origin access identity is not valid or doesn't exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "TooManyTrustedSigners", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more trusted signers than are allowed per distribution.\n " }, { "shape_name": "TrustedSignerDoesNotExist", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n One or more of your trusted signers do not exist.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "TooManyStreamingDistributionCNAMEs", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "TooManyStreamingDistributions", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Processing your request would cause you to exceed the maximum number of streaming distributions allowed.\n " }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " } ], "documentation": "\n Create a new streaming distribution.\n " }, "DeleteCloudFrontOriginAccessIdentity": { "name": "DeleteCloudFrontOriginAccessIdentity2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront/{Id}", "method": "DELETE", "response_code": 204 }, "input": { "shape_name": "DeleteCloudFrontOriginAccessIdentityRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The origin access identity's id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to delete a origin access identity.\n " }, "output": null, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "NoSuchCloudFrontOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified origin access identity does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " }, { "shape_name": "CloudFrontOriginAccessIdentityInUse", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n Delete an origin access identity.\n " }, "DeleteDistribution": { "name": "DeleteDistribution2013_11_11", "http": { "uri": "/2013-11-11/distribution/{Id}", "method": "DELETE", "response_code": 204 }, "input": { "shape_name": "DeleteDistributionRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The distribution id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to delete a distribution.\n " }, "output": null, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "DistributionNotDisabled", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " } ], "documentation": "\n Delete a distribution.\n " }, "DeleteStreamingDistribution": { "name": "DeleteStreamingDistribution2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution/{Id}", "method": "DELETE", "response_code": 204 }, "input": { "shape_name": "DeleteStreamingDistributionRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The distribution id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to delete a streaming distribution.\n " }, "output": null, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "StreamingDistributionNotDisabled", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "NoSuchStreamingDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified streaming distribution does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " } ], "documentation": "\n Delete a streaming distribution.\n " }, "GetCloudFrontOriginAccessIdentity": { "name": "GetCloudFrontOriginAccessIdentity2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront/{Id}", "method": "GET" }, "input": { "shape_name": "GetCloudFrontOriginAccessIdentityRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identity's id.\n ", "location": "uri" } }, "documentation": "\n The request to get an origin access identity's information.\n " }, "output": { "shape_name": "GetCloudFrontOriginAccessIdentityResult", "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "shape_name": "CloudFrontOriginAccessIdentity", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The ID for the origin access identity. For example: E74FTE3AJFJ256A.\n ", "required": true }, "S3CanonicalUserId": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.\n ", "required": true }, "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The current configuration information for the identity.\n " } }, "documentation": "\n The origin access identity's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchCloudFrontOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified origin access identity does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the information about an origin access identity.\n " }, "GetCloudFrontOriginAccessIdentityConfig": { "name": "GetCloudFrontOriginAccessIdentityConfig2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront/{Id}/config", "method": "GET" }, "input": { "shape_name": "GetCloudFrontOriginAccessIdentityConfigRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identity's id.\n ", "location": "uri" } }, "documentation": "\n The request to get an origin access identity's configuration.\n " }, "output": { "shape_name": "GetCloudFrontOriginAccessIdentityConfigResult", "type": "structure", "members": { "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The origin access identity's configuration information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchCloudFrontOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified origin access identity does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the configuration information about an origin access identity.\n " }, "GetDistribution": { "name": "GetDistribution2013_11_11", "http": { "uri": "/2013-11-11/distribution/{Id}", "method": "GET" }, "input": { "shape_name": "GetDistributionRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "location": "uri" } }, "documentation": "\n The request to get a distribution's information.\n " }, "output": { "shape_name": "GetDistributionResult", "type": "structure", "members": { "Distribution": { "shape_name": "Distribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the distribution. For example: EDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n This response element indicates the current status of the distribution.\n When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n ", "required": true }, "InProgressInvalidationBatches": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of invalidation batches currently in progress.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The current configuration information for the distribution.\n ", "required": true } }, "documentation": "\n The distribution's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the distribution's information. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the information about a distribution.\n " }, "GetDistributionConfig": { "name": "GetDistributionConfig2013_11_11", "http": { "uri": "/2013-11-11/distribution/{Id}/config", "method": "GET" }, "input": { "shape_name": "GetDistributionConfigRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "location": "uri" } }, "documentation": "\n The request to get a distribution configuration.\n " }, "output": { "shape_name": "GetDistributionConfigResult", "type": "structure", "members": { "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The distribution's configuration information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the configuration information about a distribution.\n " }, "GetInvalidation": { "name": "GetInvalidation2013_11_11", "http": { "uri": "/2013-11-11/distribution/{DistributionId}/invalidation/{Id}", "method": "GET" }, "input": { "shape_name": "GetInvalidationRequest", "type": "structure", "members": { "DistributionId": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "required": true, "location": "uri" }, "Id": { "shape_name": "string", "type": "string", "documentation": "\n The invalidation's id.\n ", "required": true, "location": "uri" } }, "documentation": "\n The request to get an invalidation's information.\n " }, "output": { "shape_name": "GetInvalidationResult", "type": "structure", "members": { "Invalidation": { "shape_name": "Invalidation", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the invalidation request. For example: IDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The status of the invalidation request. When the invalidation batch is finished, the status is Completed.\n ", "required": true }, "CreateTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the invalidation request was first made.\n ", "required": true }, "InvalidationBatch": { "shape_name": "InvalidationBatch", "type": "structure", "members": { "Paths": { "shape_name": "Paths", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of objects that you want to invalidate.\n ", "required": true }, "Items": { "shape_name": "PathList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Path" }, "documentation": "\n A complex type that contains a list of the objects that you want to\n invalidate.\n " } }, "documentation": "\n The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags.\n If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.\n ", "required": true }, "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique name that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the Path object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request,\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request,\n CloudFront returns an InvalidationBatchAlreadyExists error.\n ", "required": true } }, "documentation": "\n The current invalidation information for the batch request.\n ", "required": true } }, "documentation": "\n The invalidation's information.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchInvalidation", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified invalidation does not exist.\n " }, { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the information about an invalidation.\n " }, "GetStreamingDistribution": { "name": "GetStreamingDistribution2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution/{Id}", "method": "GET" }, "input": { "shape_name": "GetStreamingDistributionRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The streaming distribution's id.\n ", "location": "uri" } }, "documentation": "\n The request to get a streaming distribution's information.\n " }, "output": { "shape_name": "GetStreamingDistributionResult", "type": "structure", "members": { "StreamingDistribution": { "shape_name": "StreamingDistribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n " }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The current configuration information for the streaming distribution.\n ", "required": true } }, "documentation": "\n The streaming distribution's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchStreamingDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified streaming distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the information about a streaming distribution.\n " }, "GetStreamingDistributionConfig": { "name": "GetStreamingDistributionConfig2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution/{Id}/config", "method": "GET" }, "input": { "shape_name": "GetStreamingDistributionConfigRequest", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The streaming distribution's id.\n ", "location": "uri" } }, "documentation": "\n To request to get a streaming distribution configuration.\n " }, "output": { "shape_name": "GetStreamingDistributionConfigResult", "type": "structure", "members": { "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The streaming distribution's configuration information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "NoSuchStreamingDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified streaming distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n Get the configuration information about a streaming distribution.\n " }, "ListCloudFrontOriginAccessIdentities": { "name": "ListCloudFrontOriginAccessIdentities2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront?Marker={Marker}&MaxItems={MaxItems}", "method": "GET" }, "input": { "shape_name": "ListCloudFrontOriginAccessIdentitiesRequest", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker.\n To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).\n ", "location": "uri" }, "MaxItems": { "shape_name": "string", "type": "string", "documentation": "\n The maximum number of origin access identities you want in the response body.\n ", "location": "uri" } }, "documentation": "\n The request to list origin access identities.\n " }, "output": { "shape_name": "ListCloudFrontOriginAccessIdentitiesResult", "type": "structure", "members": { "CloudFrontOriginAccessIdentityList": { "shape_name": "CloudFrontOriginAccessIdentityList", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n The value you provided for the Marker request parameter.\n ", "required": true }, "NextMarker": { "shape_name": "string", "type": "string", "documentation": "\n If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.\n " }, "MaxItems": { "shape_name": "integer", "type": "integer", "documentation": "\n The value you provided for the MaxItems request parameter.\n ", "required": true }, "IsTruncated": { "shape_name": "boolean", "type": "boolean", "documentation": "\n A flag that indicates whether more origin access identities remain to be listed.\n If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CloudFront origin access identities that were created by\n the current AWS account.\n ", "required": true }, "Items": { "shape_name": "CloudFrontOriginAccessIdentitySummaryList", "type": "list", "members": { "shape_name": "CloudFrontOriginAccessIdentitySummary", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The ID for the origin access identity. For example: E74FTE3AJFJ256A.\n ", "required": true }, "S3CanonicalUserId": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 canonical user ID for the origin access identity, which you use when\n giving the origin access identity read permission to an object in Amazon S3.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n The comment for this origin access identity, as originally specified when created.\n ", "required": true } }, "documentation": "\n Summary of the information about a CloudFront origin access identity.\n ", "xmlname": "CloudFrontOriginAccessIdentitySummary" }, "documentation": "\n A complex type that contains one\n CloudFrontOriginAccessIdentitySummary element for each origin\n access identity that was created by the current AWS account.\n " } }, "documentation": "\n The CloudFrontOriginAccessIdentityList type.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " } ], "documentation": "\n List origin access identities.\n ", "pagination": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "CloudFrontOriginAccessIdentityList", "py_input_token": [ "marker" ] } }, "ListDistributions": { "name": "ListDistributions2013_11_11", "http": { "uri": "/2013-11-11/distribution?Marker={Marker}&MaxItems={MaxItems}", "method": "GET" }, "input": { "shape_name": "ListDistributionsRequest", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker.\n To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).\n ", "location": "uri" }, "MaxItems": { "shape_name": "string", "type": "string", "documentation": "\n The maximum number of distributions you want in the response body.\n ", "location": "uri" } }, "documentation": "\n The request to list your distributions.\n " }, "output": { "shape_name": "ListDistributionsResult", "type": "structure", "members": { "DistributionList": { "shape_name": "DistributionList", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n The value you provided for the Marker request parameter.\n ", "required": true }, "NextMarker": { "shape_name": "string", "type": "string", "documentation": "\n If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.\n " }, "MaxItems": { "shape_name": "integer", "type": "integer", "documentation": "\n The value you provided for the MaxItems request parameter.\n ", "required": true }, "IsTruncated": { "shape_name": "boolean", "type": "boolean", "documentation": "\n A flag that indicates whether more distributions remain to be listed.\n If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of distributions that were created by the current AWS account.\n ", "required": true }, "Items": { "shape_name": "DistributionSummaryList", "type": "list", "members": { "shape_name": "DistributionSummary", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the distribution. For example: EDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n This response element indicates the current status of the distribution.\n When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponses elements.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n The comment originally specified when this distribution was created.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": null, "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n ", "required": true }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n ", "required": true } }, "documentation": "\n A summary of the information for an Amazon CloudFront distribution.\n ", "xmlname": "DistributionSummary" }, "documentation": "\n A complex type that contains one DistributionSummary element for\n each distribution that was created by the current AWS account.\n " } }, "documentation": "\n The DistributionList type.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " } ], "documentation": "\n List distributions.\n ", "pagination": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "DistributionList", "py_input_token": [ "marker" ] } }, "ListInvalidations": { "name": "ListInvalidations2013_11_11", "http": { "uri": "/2013-11-11/distribution/{DistributionId}/invalidation?Marker={Marker}&MaxItems={MaxItems}", "method": "GET" }, "input": { "shape_name": "ListInvalidationsRequest", "type": "structure", "members": { "DistributionId": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "required": true, "location": "uri" }, "Marker": { "shape_name": "string", "type": "string", "documentation": "\n Use this parameter when paginating results to indicate where to begin in your list of invalidation batches.\n Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on.\n To get the next page of results, set the Marker to the value of the NextMarker from the current page's response.\n This value is the same as the ID of the last invalidation batch on that page.\n ", "location": "uri" }, "MaxItems": { "shape_name": "string", "type": "string", "documentation": "\n The maximum number of invalidation batches you want in the response body.\n ", "location": "uri" } }, "documentation": "\n The request to list invalidations.\n " }, "output": { "shape_name": "ListInvalidationsResult", "type": "structure", "members": { "InvalidationList": { "shape_name": "InvalidationList", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n The value you provided for the Marker request parameter.\n ", "required": true }, "NextMarker": { "shape_name": "string", "type": "string", "documentation": "\n If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off.\n " }, "MaxItems": { "shape_name": "integer", "type": "integer", "documentation": "\n The value you provided for the MaxItems request parameter.\n ", "required": true }, "IsTruncated": { "shape_name": "boolean", "type": "boolean", "documentation": "\n A flag that indicates whether more invalidation batch requests remain to be listed.\n If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of invalidation batches that were created by the current AWS\n account.\n ", "required": true }, "Items": { "shape_name": "InvalidationSummaryList", "type": "list", "members": { "shape_name": "InvalidationSummary", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The unique ID for an invalidation request.\n ", "required": true }, "CreateTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": null, "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The status of an invalidation request.\n ", "required": true } }, "documentation": "\n Summary of an invalidation request.\n ", "xmlname": "InvalidationSummary" }, "documentation": "\n A complex type that contains one InvalidationSummary element for\n each invalidation batch that was created by the current AWS account.\n " } }, "documentation": "\n Information about invalidation batches.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " } ], "documentation": "\n List invalidation batches.\n ", "pagination": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "InvalidationList", "py_input_token": [ "marker" ] } }, "ListStreamingDistributions": { "name": "ListStreamingDistributions2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution?Marker={Marker}&MaxItems={MaxItems}", "method": "GET" }, "input": { "shape_name": "ListStreamingDistributionsRequest", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker.\n To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).\n ", "location": "uri" }, "MaxItems": { "shape_name": "string", "type": "string", "documentation": "\n The maximum number of streaming distributions you want in the response body.\n ", "location": "uri" } }, "documentation": "\n The request to list your streaming distributions.\n " }, "output": { "shape_name": "ListStreamingDistributionsResult", "type": "structure", "members": { "StreamingDistributionList": { "shape_name": "StreamingDistributionList", "type": "structure", "members": { "Marker": { "shape_name": "string", "type": "string", "documentation": "\n The value you provided for the Marker request parameter.\n ", "required": true }, "NextMarker": { "shape_name": "string", "type": "string", "documentation": "\n If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off.\n " }, "MaxItems": { "shape_name": "integer", "type": "integer", "documentation": "\n The value you provided for the MaxItems request parameter.\n ", "required": true }, "IsTruncated": { "shape_name": "boolean", "type": "boolean", "documentation": "\n A flag that indicates whether more streaming distributions remain to be listed.\n If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of streaming distributions that were created by the current\n AWS account.\n ", "required": true }, "Items": { "shape_name": "StreamingDistributionSummaryList", "type": "list", "members": { "shape_name": "StreamingDistributionSummary", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the distribution. For example: EDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n Indicates the current status of the distribution.\n When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n The comment originally specified when this distribution was created.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": null, "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n A summary of the information for an Amazon CloudFront streaming distribution.\n ", "xmlname": "StreamingDistributionSummary" }, "documentation": "\n A complex type that contains one StreamingDistributionSummary\n element for each distribution that was created by the current AWS\n account. \n " } }, "documentation": "\n The StreamingDistributionList type.\n ", "payload": true } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " } ], "documentation": "\n List streaming distributions.\n ", "pagination": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "StreamingDistributionList", "py_input_token": [ "marker" ] } }, "UpdateCloudFrontOriginAccessIdentity": { "name": "UpdateCloudFrontOriginAccessIdentity2013_11_11", "http": { "uri": "/2013-11-11/origin-access-identity/cloudfront/{Id}/config", "method": "PUT" }, "input": { "shape_name": "UpdateCloudFrontOriginAccessIdentityRequest", "type": "structure", "members": { "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The identity's configuration information.\n ", "required": true, "payload": true }, "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identity's id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to update an origin access identity.\n " }, "output": { "shape_name": "UpdateCloudFrontOriginAccessIdentityResult", "type": "structure", "members": { "CloudFrontOriginAccessIdentity": { "shape_name": "CloudFrontOriginAccessIdentity", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The ID for the origin access identity. For example: E74FTE3AJFJ256A.\n ", "required": true }, "S3CanonicalUserId": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.\n ", "required": true }, "CloudFrontOriginAccessIdentityConfig": { "shape_name": "CloudFrontOriginAccessIdentityConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.\n If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,\n CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the origin access identity.\n ", "required": true } }, "documentation": "\n The current configuration information for the identity.\n " } }, "documentation": "\n The origin access identity's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "IllegalUpdate", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Origin and CallerReference cannot be updated.\n " }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "NoSuchCloudFrontOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified origin access identity does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " } ], "documentation": "\n Update an origin access identity.\n " }, "UpdateDistribution": { "name": "UpdateDistribution2013_11_11", "http": { "uri": "/2013-11-11/distribution/{Id}/config", "method": "PUT" }, "input": { "shape_name": "UpdateDistributionRequest", "type": "structure", "members": { "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The distribution's configuration information.\n ", "required": true, "payload": true }, "Id": { "shape_name": "string", "type": "string", "documentation": "\n The distribution's id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to update a distribution.\n " }, "output": { "shape_name": "UpdateDistributionResult", "type": "structure", "members": { "Distribution": { "shape_name": "Distribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the distribution. For example: EDFDVBD632BHDS5.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n This response element indicates the current status of the distribution.\n When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n ", "required": true }, "InProgressInvalidationBatches": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of invalidation batches currently in progress.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "DistributionConfig": { "shape_name": "DistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.\n ", "required": true }, "DefaultRootObject": { "shape_name": "string", "type": "string", "documentation": "\n The object that you want CloudFront to return (for example, index.html)\n when an end user requests the root URL for your distribution\n (http://www.example.com) instead of an object in your distribution\n (http://www.example.com/index.html). Specifying a default root\n object avoids exposing the contents of your distribution.\n If you don't want to specify a default root object when you create a\n distribution, include an empty DefaultRootObject element.\n To delete the default root object from an existing distribution, update the\n distribution configuration and include an empty DefaultRootObject\n element. To replace the default root object, update the distribution configuration\n and specify the new object.\n ", "required": true }, "Origins": { "shape_name": "Origins", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of origins for this distribution.\n ", "required": true }, "Items": { "shape_name": "OriginList", "type": "list", "members": { "shape_name": "Origin", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n A unique identifier for the origin. The value of Id must be unique within\n the distribution.\n You use the value of Id when you create a cache behavior. The Id\n identifies the origin that CloudFront routes a request to when the request\n matches the path pattern for that cache behavior.\n ", "required": true }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n Amazon S3 origins: The DNS name of the Amazon S3 bucket from\n which you want CloudFront to get objects for this origin, for example,\n myawsbucket.s3.amazonaws.com.\n Custom origins: The DNS domain name for the HTTP server from which\n you want CloudFront to get objects for this origin, for example,\n www.example.com.\n ", "required": true }, "S3OriginConfig": { "shape_name": "S3OriginConfig", "type": "structure", "members": { "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n The CloudFront origin access identity to associate with the origin. Use\n an origin access identity to configure the origin so that end users can\n only access objects in an Amazon S3 bucket through CloudFront.\n If you want end users to be able to access objects using either the\n CloudFront URL or the Amazon S3 URL, specify an empty\n OriginAccessIdentity element.\n To delete the origin access identity from an existing distribution, update\n the distribution configuration and include an empty\n OriginAccessIdentity element.\n To replace the origin access identity, update the distribution configuration\n and specify the new origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3 origin. If\n the origin is a custom origin, use the CustomOriginConfig element\n instead.\n " }, "CustomOriginConfig": { "shape_name": "CustomOriginConfig", "type": "structure", "members": { "HTTPPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTP port the custom origin listens on.\n ", "required": true }, "HTTPSPort": { "shape_name": "integer", "type": "integer", "documentation": "\n The HTTPS port the custom origin listens on.\n ", "required": true }, "OriginProtocolPolicy": { "shape_name": "OriginProtocolPolicy", "type": "string", "enum": [ "http-only", "match-viewer" ], "documentation": "\n The origin protocol policy to apply to your origin.\n ", "required": true } }, "documentation": "\n A complex type that contains information about a custom origin. If the\n origin is an Amazon S3 bucket, use the S3OriginConfig element\n instead.\n " } }, "documentation": "\n A complex type that describes the Amazon S3 bucket or the HTTP server\n (for example, a web server) from which CloudFront gets your files.You\n must create at least one origin.\n ", "xmlname": "Origin" }, "min_length": 1, "documentation": "\n A complex type that contains origins for this distribution.\n " } }, "documentation": "\n A complex type that contains information about origins for this distribution.\n ", "required": true }, "DefaultCacheBehavior": { "shape_name": "DefaultCacheBehavior", "type": "structure", "members": { "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes the default cache behavior if you do not\n specify a CacheBehavior element or if files don't match any of the values\n of PathPattern in CacheBehavior elements.You must create exactly\n one default cache behavior.\n ", "required": true }, "CacheBehaviors": { "shape_name": "CacheBehaviors", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of cache behaviors for this distribution.\n ", "required": true }, "Items": { "shape_name": "CacheBehaviorList", "type": "list", "members": { "shape_name": "CacheBehavior", "type": "structure", "members": { "PathPattern": { "shape_name": "string", "type": "string", "documentation": "\n The pattern (for example, images/*.jpg) that specifies which requests\n you want this cache behavior to apply to. When CloudFront receives an\n end-user request, the requested path is compared with path patterns in\n the order in which cache behaviors are listed in the distribution.\n The path pattern for the default cache behavior is * and cannot be\n changed. If the request for an object does not match the path pattern for\n any cache behaviors, CloudFront applies the behavior in the default cache\n behavior.\n ", "required": true }, "TargetOriginId": { "shape_name": "string", "type": "string", "documentation": "\n The value of ID for the origin that you want CloudFront to route requests\n to when a request matches the path pattern either for a cache behavior\n or for the default cache behavior.\n ", "required": true }, "ForwardedValues": { "shape_name": "ForwardedValues", "type": "structure", "members": { "QueryString": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Indicates whether you want CloudFront to forward query strings to the\n origin that is associated with this cache behavior. If so, specify true; if\n not, specify false.\n ", "required": true }, "Cookies": { "shape_name": "CookiePreference", "type": "structure", "members": { "Forward": { "shape_name": "ItemSelection", "type": "string", "enum": [ "none", "whitelist", "all" ], "documentation": "\n Use this element to specify whether you want CloudFront to forward cookies to the origin that is\n associated with this cache behavior. You can specify all, none or whitelist. If you choose All,\n CloudFront forwards all cookies regardless of how many your application uses.\n ", "required": true }, "WhitelistedNames": { "shape_name": "CookieNames", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of whitelisted cookies for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "CookieNameList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Name" }, "documentation": "\n Optional: A complex type that contains whitelisted cookies for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your\n origin that is associated with this cache behavior.\n " } }, "documentation": "\n A complex type that specifies how CloudFront handles cookies.\n ", "required": true } }, "documentation": "\n A complex type that specifies how CloudFront handles query strings and cookies.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "ViewerProtocolPolicy": { "shape_name": "ViewerProtocolPolicy", "type": "string", "enum": [ "allow-all", "https-only" ], "documentation": "\n Use this element to specify the protocol that users can use to access the\n files in the origin specified by TargetOriginId when a request matches\n the path pattern in PathPattern. If you want CloudFront to allow end\n users to use any available protocol, specify allow-all. If you want\n CloudFront to require HTTPS, specify https.\n ", "required": true }, "MinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time that you want objects to stay in CloudFront\n caches before CloudFront queries your origin to see whether the object\n has been updated.You can specify a value from 0 to 3,153,600,000\n seconds (100 years).\n ", "required": true }, "AllowedMethods": { "shape_name": "AllowedMethods", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n\tThe number of HTTP methods that you want CloudFront to forward to your origin. \n\tValid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, \n\tOPTIONS, PATCH, POST, and PUT requests).\n ", "required": true }, "Items": { "shape_name": "AllowedMethodsList", "type": "list", "members": { "shape_name": "Method", "type": "string", "enum": [ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ], "documentation": null, "xmlname": "Method" }, "documentation": "\n\tA complex type that contains the HTTP methods that you want \n\tCloudFront to process and forward to your origin. \n " } }, "documentation": "\n\tA complex type that controls which HTTP methods CloudFront processes and \n\tforwards to your Amazon S3 bucket or your custom origin. There are two \n\toptions:\n\t- CloudFront forwards only GET and HEAD requests.\n\t- CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT\n\trequests.\n\tIf you choose the second option, you may need to restrict access to your \n\tAmazon S3 bucket or to your custom origin so users can't perform operations \n\tthat you don't want them to. For example, you may not want users to have \n\tpermission to delete objects from your origin.\n " } }, "documentation": "\n A complex type that describes how CloudFront processes requests.\n You can create up to 10 cache behaviors.You must create at least as\n many cache behaviors (including the default cache behavior) as you have\n origins if you want CloudFront to distribute objects from all of the origins.\n Each cache behavior specifies the one origin from which you want\n CloudFront to get objects. If you have two origins and only the default\n cache behavior, the default cache behavior will cause CloudFront to get\n objects from one of the origins, but the other origin will never be used.\n If you don't want to specify any cache behaviors, include only an empty\n CacheBehaviors element. Don't include an empty CacheBehavior\n element, or CloudFront returns a MalformedXML error.\n To delete all cache behaviors in an existing distribution, update the\n distribution configuration and include only an empty CacheBehaviors\n element.\n To add, change, or remove one or more cache behaviors, update the\n distribution configuration and specify all of the cache behaviors that you\n want to include in the updated distribution.\n ", "xmlname": "CacheBehavior" }, "documentation": "\n Optional: A complex type that contains cache behaviors for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CacheBehavior elements.\n ", "required": true }, "CustomErrorResponses": { "shape_name": "CustomErrorResponses", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of custom error responses for this distribution.\n ", "required": true }, "Items": { "shape_name": "CustomErrorResponseList", "type": "list", "members": { "shape_name": "CustomErrorResponse", "type": "structure", "members": { "ErrorCode": { "shape_name": "integer", "type": "integer", "documentation": "\n The 4xx or 5xx HTTP status code that you want to customize. For a list of \n HTTP status codes that you can customize, see CloudFront documentation.\n ", "required": true }, "ResponsePagePath": { "shape_name": "string", "type": "string", "documentation": "\n The path of the custom error page (for example, /custom_404.html). The \n path is relative to the distribution and must begin with a slash (/). If\n the path includes any non-ASCII characters or unsafe characters as defined \n in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.\n Do not URL encode any other characters in the path, or CloudFront will not \n return the custom error page to the viewer.\n " }, "ResponseCode": { "shape_name": "string", "type": "string", "documentation": "\n The HTTP status code that you want CloudFront to return with the custom error \n page to the viewer. For a list of HTTP status codes that you can replace, see \n CloudFront Documentation.\n " }, "ErrorCachingMinTTL": { "shape_name": "long", "type": "long", "documentation": "\n The minimum amount of time you want HTTP error codes to stay in CloudFront caches \n before CloudFront queries your origin to see whether the object has been updated.\n You can specify a value from 0 to 31,536,000. \n " } }, "documentation": "\n A complex type that describes how you'd prefer CloudFront to respond to\n requests that result in either a 4xx or 5xx response. You can control \n whether a custom error page should be displayed, what the desired response\n code should be for this error page and how long should the error response\n be cached by CloudFront.\n If you don't want to specify any custom error responses, include only an \n empty CustomErrorResponses element. \n To delete all custom error responses in an existing distribution, update the\n distribution configuration and include only an empty CustomErrorResponses\n element.\n To add, change, or remove one or more custom error responses, update the\n distribution configuration and specify all of the custom error responses that\n you want to include in the updated distribution.\n ", "xmlname": "CustomErrorResponse" }, "documentation": "\n Optional: A complex type that contains custom error responses for this\n distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains zero or more CustomErrorResponse elements.\n " }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the distribution.\n ", "required": true }, "Logging": { "shape_name": "LoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a distribution or if\n you want to disable logging for an existing distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket, prefix and\n IncludeCookies, the values are automatically deleted.\n ", "required": true }, "IncludeCookies": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to include cookies in access logs, specify true for\n IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless\n of how you configure the cache behaviors for this distribution.\n If you do not want to include cookies when you create a distribution or if you want to \n disable include cookies for an existing distribution, specify false for IncludeCookies.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the distribution is enabled to accept end user requests for content.\n ", "required": true }, "ViewerCertificate": { "shape_name": "ViewerCertificate", "type": "structure", "members": { "IAMCertificateId": { "shape_name": "string", "type": "string", "documentation": "\n The IAM certificate identifier of the custom viewer certificate for this distribution.\n " }, "CloudFrontDefaultCertificate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Set to true if you want to use the default *.cloudfront.net viewer certificate for this distribution.\n Omit this value if you are setting an IAMCertificateId.\n " } }, "documentation": "\n A complex type that contains information about viewer certificates for this distribution.\n " }, "Restrictions": { "shape_name": "Restrictions", "type": "structure", "members": { "GeoRestriction": { "shape_name": "GeoRestriction", "type": "structure", "members": { "RestrictionType": { "shape_name": "GeoRestrictionType", "type": "string", "enum": [ "blacklist", "whitelist", "none" ], "documentation": "\n The method that you want to use to restrict distribution of your content by country:\n - none: No geo restriction is enabled, meaning access to content is not restricted\n by client geo location.\n - blacklist: The Location elements specify the countries in which you do not want \n CloudFront to distribute your content.\n - whitelist: The Location elements specify the countries in which you want CloudFront \n to distribute your content.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n When geo restriction is enabled, this is the number of countries in your whitelist \n or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.\n ", "required": true }, "Items": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "Location" }, "documentation": "\n A complex type that contains a Location element for each country in which you want \n CloudFront either to distribute your content (whitelist) or not distribute your \n content (blacklist). \n\n The Location element is a two-letter, uppercase country code for a country that \n you want to include in your blacklist or whitelist. Include one Location element \n for each country.\n\n CloudFront and MaxMind both use ISO 3166 country codes. For the current list of \n countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International \n Organization for Standardization website. You can also refer to the country list \n in the CloudFront console, which includes both country names and codes.\n " } }, "documentation": "\n A complex type that controls the countries in which your content is distributed. \n For more information about geo restriction, go to Customizing Error Responses in \n the Amazon CloudFront Developer Guide.\n\n CloudFront determines the location of your users using MaxMind GeoIP databases. \n For information about the accuracy of these databases, see How accurate are \n your GeoIP databases? on the MaxMind website.\n ", "required": true } }, "documentation": "\n A complex type that identifies ways in which you want to restrict distribution \n of your content.\n " } }, "documentation": "\n The current configuration information for the distribution.\n ", "required": true } }, "documentation": "\n The distribution's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "CNAMEAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "IllegalUpdate", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Origin and CallerReference cannot be updated.\n " }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "NoSuchDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified distribution does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " }, { "shape_name": "TooManyDistributionCNAMEs", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more CNAMEs than are allowed per distribution.\n " }, { "shape_name": "InvalidDefaultRootObject", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The default root object file name is too big or contains an invalid character.\n " }, { "shape_name": "InvalidRelativePath", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The relative path is too big, is not URL-encoded, or\n does not begin with a slash (/).\n " }, { "shape_name": "InvalidErrorCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidResponseCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InvalidOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The origin access identity is not valid or doesn't exist.\n " }, { "shape_name": "TooManyTrustedSigners", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more trusted signers than are allowed per distribution.\n " }, { "shape_name": "TrustedSignerDoesNotExist", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n One or more of your trusted signers do not exist.\n " }, { "shape_name": "InvalidViewerCertificate", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidRequiredProtocol", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.\n " }, { "shape_name": "NoSuchOrigin", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n No origin exists with the specified Origin Id.\n " }, { "shape_name": "TooManyOrigins", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore origins for the distribution. \n " }, { "shape_name": "TooManyCacheBehaviors", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore cache behaviors for the distribution.\n " }, { "shape_name": "TooManyCookieNamesInWhiteList", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more cookie names in the whitelist than are allowed per cache behavior.\n " }, { "shape_name": "InvalidForwardCookies", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains forward cookies option which doesn't match with the expectation for the whitelisted\n list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names\n is missing when expected.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " }, { "shape_name": "TooManyCertificates", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n You cannot create anymore custom ssl certificates.\n " }, { "shape_name": "InvalidLocationCode", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidGeoRestrictionParameter", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n Update a distribution.\n " }, "UpdateStreamingDistribution": { "name": "UpdateStreamingDistribution2013_11_11", "http": { "uri": "/2013-11-11/streaming-distribution/{Id}/config", "method": "PUT" }, "input": { "shape_name": "UpdateStreamingDistributionRequest", "type": "structure", "members": { "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The streaming distribution's configuration information.\n ", "required": true, "payload": true }, "Id": { "shape_name": "string", "type": "string", "documentation": "\n The streaming distribution's id.\n ", "location": "uri" }, "IfMatch": { "shape_name": "string", "type": "string", "documentation": "\n The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "If-Match" } }, "documentation": "\n The request to update a streaming distribution.\n " }, "output": { "shape_name": "UpdateStreamingDistributionResult", "type": "structure", "members": { "StreamingDistribution": { "shape_name": "StreamingDistribution", "type": "structure", "members": { "Id": { "shape_name": "string", "type": "string", "documentation": "\n The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.\n ", "required": true }, "Status": { "shape_name": "string", "type": "string", "documentation": "\n The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.\n ", "required": true }, "LastModifiedTime": { "shape_name": "timestamp", "type": "timestamp", "documentation": "\n The date and time the distribution was last modified.\n " }, "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.\n ", "required": true }, "ActiveTrustedSigners": { "shape_name": "ActiveTrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Each active trusted signer.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of unique trusted signers included in all\n cache behaviors. For example, if three cache\n behaviors all list the same three AWS accounts, the\n value of Quantity for ActiveTrustedSigners will\n be 3.\n ", "required": true }, "Items": { "shape_name": "SignerList", "type": "list", "members": { "shape_name": "Signer", "type": "structure", "members": { "AwsAccountNumber": { "shape_name": "string", "type": "string", "documentation": "\n Specifies an AWS account that can create signed URLs.\n Values: self, which indicates that the AWS account that was used to create\n the distribution can created signed URLs, or\n an AWS account number. Omit the dashes in the account number.\n " }, "KeyPairIds": { "shape_name": "KeyPairIds", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of active CloudFront key pairs for\n AwsAccountNumber.\n ", "required": true }, "Items": { "shape_name": "KeyPairIdList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "KeyPairId" }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the active CloudFront key\n pairs, if any, that are associated with\n AwsAccountNumber.\n " } }, "documentation": "\n A complex type that lists the AWS accounts that were\n included in the TrustedSigners complex type, as\n well as their active CloudFront key pair IDs, if any.\n ", "xmlname": "Signer" }, "documentation": "\n A complex type that contains one Signer complex\n type for each unique trusted signer that is specified in\n the TrustedSigners complex type, including trusted\n signers in the default cache behavior and in all of the\n other cache behaviors.\n " } }, "documentation": "\n CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs.\n The element lists the key pair IDs that CloudFront is aware of for each trusted signer.\n The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you).\n The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.\n ", "required": true }, "StreamingDistributionConfig": { "shape_name": "StreamingDistributionConfig", "type": "structure", "members": { "CallerReference": { "shape_name": "string", "type": "string", "documentation": "\n A unique number that ensures the request can't be replayed.\n If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space),\n the response includes the same information returned to the original request.\n If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request,\n CloudFront returns a DistributionAlreadyExists error.\n ", "required": true }, "S3Origin": { "shape_name": "S3Origin", "type": "structure", "members": { "DomainName": { "shape_name": "string", "type": "string", "documentation": "\n The DNS name of the S3 origin.\n ", "required": true }, "OriginAccessIdentity": { "shape_name": "string", "type": "string", "documentation": "\n Your S3 origin's origin access identity.\n ", "required": true } }, "documentation": "\n A complex type that contains information about the Amazon S3\n bucket from which you want CloudFront to get your media files for\n distribution.\n ", "required": true }, "Aliases": { "shape_name": "Aliases", "type": "structure", "members": { "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of CNAMEs, if any, for this distribution.\n ", "required": true }, "Items": { "shape_name": "AliasList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "CNAME" }, "documentation": "\n Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.\n ", "required": true }, "Comment": { "shape_name": "string", "type": "string", "documentation": "\n Any comments you want to include about the streaming distribution.\n ", "required": true }, "Logging": { "shape_name": "StreamingLoggingConfig", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want CloudFront to save access logs to an Amazon\n S3 bucket.\n If you do not want to enable logging when you create a streaming distribution or if\n you want to disable logging for an existing streaming distribution, specify false for\n Enabled, and specify empty Bucket and Prefix elements.\n If you specify false for Enabled but you specify values for Bucket and\n Prefix, the values are automatically deleted.\n ", "required": true }, "Bucket": { "shape_name": "string", "type": "string", "documentation": "\n The Amazon S3 bucket to store the access logs in, for example,\n myawslogbucket.s3.amazonaws.com.\n ", "required": true }, "Prefix": { "shape_name": "string", "type": "string", "documentation": "\n An optional string that you want CloudFront to prefix to the access log\n filenames for this streaming distribution, for example, myprefix/.\n If you want to enable logging, but you do not want to specify a prefix, you\n still must include an empty Prefix element in the Logging element.\n ", "required": true } }, "documentation": "\n A complex type that controls whether access logs are written for the streaming distribution.\n ", "required": true }, "TrustedSigners": { "shape_name": "TrustedSigners", "type": "structure", "members": { "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Specifies whether you want to require end users to use signed URLs to\n access the files specified by PathPattern and TargetOriginId.\n ", "required": true }, "Quantity": { "shape_name": "integer", "type": "integer", "documentation": "\n The number of trusted signers for this cache behavior.\n ", "required": true }, "Items": { "shape_name": "AwsAccountNumberList", "type": "list", "members": { "shape_name": "string", "type": "string", "documentation": null, "xmlname": "AwsAccountNumber" }, "documentation": "\n Optional: A complex type that contains trusted signers for this cache\n behavior. If Quantity is 0, you can omit Items.\n " } }, "documentation": "\n A complex type that specifies the AWS accounts, if any, that you want\n to allow to create signed URLs for private content.\n If you want to require signed URLs in requests for objects in the target\n origin that match the PathPattern for this cache behavior, specify true\n for Enabled, and specify the applicable values for Quantity and Items.\n For more information, go to Using a Signed URL to Serve Private Content\n in the Amazon CloudFront Developer Guide.\n If you don't want to require signed URLs in requests for objects that match\n PathPattern, specify false for Enabled and 0 for Quantity. Omit\n Items.\n To add, change, or remove one or more trusted signers, change Enabled\n to true (if it's currently false), change Quantity as applicable, and\n specify all of the trusted signers that you want to include in the updated\n distribution.\n ", "required": true }, "PriceClass": { "shape_name": "PriceClass", "type": "string", "enum": [ "PriceClass_100", "PriceClass_200", "PriceClass_All" ], "documentation": "\n A complex type that contains information about price class for this streaming distribution.\n ", "required": true }, "Enabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n Whether the streaming distribution is enabled to accept end user requests for content.\n ", "required": true } }, "documentation": "\n The current configuration information for the streaming distribution.\n ", "required": true } }, "documentation": "\n The streaming distribution's information.\n ", "payload": true }, "ETag": { "shape_name": "string", "type": "string", "documentation": "\n The current version of the configuration. For example: E2QWRUHAPOMQZL.\n ", "location": "header", "location_name": "ETag" } }, "documentation": "\n The returned result of the corresponding request.\n " }, "errors": [ { "shape_name": "AccessDenied", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Access denied.\n " }, { "shape_name": "CNAMEAlreadyExists", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "IllegalUpdate", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Origin and CallerReference cannot be updated.\n " }, { "shape_name": "InvalidIfMatchVersion", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The If-Match version is missing or not valid for the distribution.\n " }, { "shape_name": "MissingBody", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n This operation requires a body. Ensure that the body is present and the Content-Type header is set.\n " }, { "shape_name": "NoSuchStreamingDistribution", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The specified streaming distribution does not exist.\n " }, { "shape_name": "PreconditionFailed", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The precondition given in one or more of the request-header fields evaluated to false.\n " }, { "shape_name": "TooManyStreamingDistributionCNAMEs", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidArgument", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The argument is invalid.\n " }, { "shape_name": "InvalidOriginAccessIdentity", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The origin access identity is not valid or doesn't exist.\n " }, { "shape_name": "TooManyTrustedSigners", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n Your request contains more trusted signers than are allowed per distribution.\n " }, { "shape_name": "TrustedSignerDoesNotExist", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n One or more of your trusted signers do not exist.\n " }, { "shape_name": "InconsistentQuantities", "type": "structure", "members": { "Message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n The value of Quantity and the size of Items do not match.\n " } ], "documentation": "\n Update a streaming distribution.\n " } }, "metadata": { "protocols": [ "https" ], "regions": { "us-east-1": "https://cloudfront.amazonaws.com/" } }, "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "CloudFrontOriginAccessIdentityList", "py_input_token": [ "marker" ] }, "ListDistributions": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "DistributionList", "py_input_token": [ "marker" ] }, "ListInvalidations": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "InvalidationList", "py_input_token": [ "marker" ] }, "ListStreamingDistributions": { "input_token": [ "Marker" ], "limit_key": "MaxItems", "more_key": "IsTruncated", "output_token": [ "NextMarker" ], "result_key": "StreamingDistributionList", "py_input_token": [ "marker" ] } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/cloudsearch.json0000644000175000017500000077502412254746564021454 0ustar takakitakaki{ "api_version": "2011-02-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon CloudSearch", "endpoint_prefix": "cloudsearch", "xmlnamespace": "http://cloudsearch.amazonaws.com/doc/2011-02-01", "documentation": "\n Amazon CloudSearch Configuration Service\n

You use the Configuration Service to create, configure, and manage search domains. \n Amazon CloudSearch configuration requests are submitted to cloudsearch.us-east-1.amazonaws.com\n using the AWS Query protocol.

\n ", "operations": { "CreateDomain": { "name": "CreateDomain", "input": { "shape_name": "CreateDomainRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "CreateDomainResponse", "type": "structure", "members": { "DomainStatus": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

An internally generated unique identifier for a domain.

\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

\n " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The number of documents that have been submitted to the domain and indexed.

\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for updating documents in a search domain.

\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for requesting search results from a search domain.

\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if IndexDocuments needs to be called to activate the current domain configuration.

\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if processing is being done to activate the current domain configuration.

\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\n

The instance type (such as search.m1.small) that is being used to process search requests.

\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of partitions across which the search index is spread.

\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of search instances that are available to process search requests.

\n " } }, "documentation": "\n

The current status of the search domain.

\n " } }, "documentation": "\n

A response message that contains the status of a newly created domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " } ], "documentation": "\n

Creates a new search domain.

\n " }, "DefineIndexField": { "name": "DefineIndexField", "input": { "shape_name": "DefineIndexFieldRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "IndexField": { "shape_name": "IndexField", "type": "structure", "members": { "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\n

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The default value for an unsigned integer field. Optional.

\n " } }, "documentation": "\n

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

\n " }, "LiteralOptions": { "shape_name": "LiteralOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a literal field. Optional.

\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether search is enabled for this field. Default: False.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " } }, "documentation": "\n

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

\n " }, "TextOptions": { "shape_name": "TextOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a text field. Optional.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The text processor to apply to this field. Optional. Possible values:

\n \n

Default: none

\n " } }, "documentation": "\n

Options for text field. Present if IndexFieldType specifies the field is of type text.

\n " }, "SourceAttributes": { "shape_name": "SourceAttributeList", "type": "list", "members": { "shape_name": "SourceAttribute", "type": "structure", "members": { "SourceDataFunction": { "shape_name": "SourceDataFunction", "type": "string", "enum": [ "Copy", "TrimTitle", "Map" ], "documentation": "\n

Identifies the transformation to apply when copying data from a source attribute.

\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " } }, "documentation": "\n

Copies data from a source document attribute to an IndexField.

\n " }, "SourceDataTrimTitle": { "shape_name": "SourceDataTrimTitle", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\n

The separator that follows the text to trim.

\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\n

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

\n " } }, "documentation": "\n

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

\n " }, "SourceDataMap": { "shape_name": "SourceDataMap", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "documentation": "\n

A map that translates source field values to custom values.

\n " } }, "documentation": "\n

Maps source document attribute values to new values when populating the IndexField.

\n " } }, "documentation": "\n

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

\n " }, "documentation": "\n

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

\n " } }, "documentation": "\n

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DefineIndexFieldResponse", "type": "structure", "members": { "IndexField": { "shape_name": "IndexFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "IndexField", "type": "structure", "members": { "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\n

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The default value for an unsigned integer field. Optional.

\n " } }, "documentation": "\n

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

\n " }, "LiteralOptions": { "shape_name": "LiteralOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a literal field. Optional.

\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether search is enabled for this field. Default: False.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " } }, "documentation": "\n

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

\n " }, "TextOptions": { "shape_name": "TextOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a text field. Optional.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The text processor to apply to this field. Optional. Possible values:

\n \n

Default: none

\n " } }, "documentation": "\n

Options for text field. Present if IndexFieldType specifies the field is of type text.

\n " }, "SourceAttributes": { "shape_name": "SourceAttributeList", "type": "list", "members": { "shape_name": "SourceAttribute", "type": "structure", "members": { "SourceDataFunction": { "shape_name": "SourceDataFunction", "type": "string", "enum": [ "Copy", "TrimTitle", "Map" ], "documentation": "\n

Identifies the transformation to apply when copying data from a source attribute.

\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " } }, "documentation": "\n

Copies data from a source document attribute to an IndexField.

\n " }, "SourceDataTrimTitle": { "shape_name": "SourceDataTrimTitle", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\n

The separator that follows the text to trim.

\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\n

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

\n " } }, "documentation": "\n

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

\n " }, "SourceDataMap": { "shape_name": "SourceDataMap", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "documentation": "\n

A map that translates source field values to custom values.

\n " } }, "documentation": "\n

Maps source document attribute values to new values when populating the IndexField.

\n " } }, "documentation": "\n

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

\n " }, "documentation": "\n

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

\n " } }, "documentation": "\n

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of an IndexField and its current status.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of an updated index field.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

\n " }, "DefineRankExpression": { "name": "DefineRankExpression", "input": { "shape_name": "DefineRankExpressionRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "RankExpression": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\n

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

\n\n\n

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

\n

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

\n

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

\n ", "required": true } }, "documentation": "\n

A named expression that can be evaluated at search time and used for ranking or thresholding\n in a search query.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DefineRankExpressionResponse", "type": "structure", "members": { "RankExpression": { "shape_name": "RankExpressionStatus", "type": "structure", "members": { "Options": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\n

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

\n\n\n

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

\n

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

\n

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

\n ", "required": true } }, "documentation": "\n

The expression that is evaluated for ranking or thresholding while processing a search request.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of a RankExpression and its current status.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of an updated RankExpression.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

\n " }, "DeleteDomain": { "name": "DeleteDomain", "input": { "shape_name": "DeleteDomainRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteDomainResponse", "type": "structure", "members": { "DomainStatus": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

An internally generated unique identifier for a domain.

\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

\n " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The number of documents that have been submitted to the domain and indexed.

\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for updating documents in a search domain.

\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for requesting search results from a search domain.

\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if IndexDocuments needs to be called to activate the current domain configuration.

\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if processing is being done to activate the current domain configuration.

\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\n

The instance type (such as search.m1.small) that is being used to process search requests.

\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of partitions across which the search index is spread.

\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of search instances that are available to process search requests.

\n " } }, "documentation": "\n

The current status of the search domain.

\n " } }, "documentation": "\n

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " } ], "documentation": "\n

Permanently deletes a search domain and all of its data.

\n " }, "DeleteIndexField": { "name": "DeleteIndexField", "input": { "shape_name": "DeleteIndexFieldRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

A string that represents the name of an index field. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteIndexFieldResponse", "type": "structure", "members": { "IndexField": { "shape_name": "IndexFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "IndexField", "type": "structure", "members": { "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\n

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The default value for an unsigned integer field. Optional.

\n " } }, "documentation": "\n

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

\n " }, "LiteralOptions": { "shape_name": "LiteralOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a literal field. Optional.

\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether search is enabled for this field. Default: False.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " } }, "documentation": "\n

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

\n " }, "TextOptions": { "shape_name": "TextOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a text field. Optional.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The text processor to apply to this field. Optional. Possible values:

\n \n

Default: none

\n " } }, "documentation": "\n

Options for text field. Present if IndexFieldType specifies the field is of type text.

\n " }, "SourceAttributes": { "shape_name": "SourceAttributeList", "type": "list", "members": { "shape_name": "SourceAttribute", "type": "structure", "members": { "SourceDataFunction": { "shape_name": "SourceDataFunction", "type": "string", "enum": [ "Copy", "TrimTitle", "Map" ], "documentation": "\n

Identifies the transformation to apply when copying data from a source attribute.

\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " } }, "documentation": "\n

Copies data from a source document attribute to an IndexField.

\n " }, "SourceDataTrimTitle": { "shape_name": "SourceDataTrimTitle", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\n

The separator that follows the text to trim.

\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\n

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

\n " } }, "documentation": "\n

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

\n " }, "SourceDataMap": { "shape_name": "SourceDataMap", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "documentation": "\n

A map that translates source field values to custom values.

\n " } }, "documentation": "\n

Maps source document attribute values to new values when populating the IndexField.

\n " } }, "documentation": "\n

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

\n " }, "documentation": "\n

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

\n " } }, "documentation": "\n

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of an IndexField and its current status.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of a deleted index field.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Removes an IndexField from the search domain.

\n " }, "DeleteRankExpression": { "name": "DeleteRankExpression", "input": { "shape_name": "DeleteRankExpressionRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the RankExpression to delete.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteRankExpressionResponse", "type": "structure", "members": { "RankExpression": { "shape_name": "RankExpressionStatus", "type": "structure", "members": { "Options": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\n

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

\n\n\n

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

\n

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

\n

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

\n ", "required": true } }, "documentation": "\n

The expression that is evaluated for ranking or thresholding while processing a search request.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of a RankExpression and its current status.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of a deleted RankExpression.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Removes a RankExpression from the search domain.

\n " }, "DescribeDefaultSearchField": { "name": "DescribeDefaultSearchField", "input": { "shape_name": "DescribeDefaultSearchFieldRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeDefaultSearchFieldResponse", "type": "structure", "members": { "DefaultSearchField": { "shape_name": "DefaultSearchFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.

\n ", "required": true } }, "documentation": "\n

A response message that contains the default search field for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets the default search field configured for the search domain.

\n " }, "DescribeDomains": { "name": "DescribeDomains", "input": { "shape_name": "DescribeDomainsRequest", "type": "structure", "members": { "DomainNames": { "shape_name": "DomainNameList", "type": "list", "members": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n " }, "documentation": "\n

Limits the DescribeDomains response to the specified search domains.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeDomainsResponse", "type": "structure", "members": { "DomainStatusList": { "shape_name": "DomainStatusList", "type": "list", "members": { "shape_name": "DomainStatus", "type": "structure", "members": { "DomainId": { "shape_name": "DomainId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

An internally generated unique identifier for a domain.

\n ", "required": true }, "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Created": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

\n " }, "Deleted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

\n " }, "NumSearchableDocs": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The number of documents that have been submitted to the domain and indexed.

\n " }, "DocService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for updating documents in a search domain.

\n " }, "SearchService": { "shape_name": "ServiceEndpoint", "type": "structure", "members": { "Arn": { "shape_name": "Arn", "type": "string", "documentation": "\n

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

\n " }, "Endpoint": { "shape_name": "ServiceUrl", "type": "string", "documentation": "\n

The URL (including /version/pathPrefix) to which service requests can be submitted.

\n " } }, "documentation": "\n

The service endpoint for requesting search results from a search domain.

\n " }, "RequiresIndexDocuments": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if IndexDocuments needs to be called to activate the current domain configuration.

\n ", "required": true }, "Processing": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

True if processing is being done to activate the current domain configuration.

\n " }, "SearchInstanceType": { "shape_name": "SearchInstanceType", "type": "string", "documentation": "\n

The instance type (such as search.m1.small) that is being used to process search requests.

\n " }, "SearchPartitionCount": { "shape_name": "PartitionCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of partitions across which the search index is spread.

\n " }, "SearchInstanceCount": { "shape_name": "InstanceCount", "type": "integer", "min_length": 1, "documentation": "\n

The number of search instances that are available to process search requests.

\n " } }, "documentation": "\n

The current status of the search domain.

\n " }, "documentation": "\n

The current status of all of your search domains.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of one or more domains.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " } ], "documentation": "\n

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows\n all domains by default.

\n " }, "DescribeIndexFields": { "name": "DescribeIndexFields", "input": { "shape_name": "DescribeIndexFieldsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "FieldNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

A string that represents the name of an index field. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n\n " }, "documentation": "\n

Limits the DescribeIndexFields response to the specified fields.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeIndexFieldsResponse", "type": "structure", "members": { "IndexFields": { "shape_name": "IndexFieldStatusList", "type": "list", "members": { "shape_name": "IndexFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "IndexField", "type": "structure", "members": { "IndexFieldName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a field in the search index. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "IndexFieldType": { "shape_name": "IndexFieldType", "type": "string", "enum": [ "uint", "literal", "text" ], "documentation": "\n

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

\n ", "required": true }, "UIntOptions": { "shape_name": "UIntOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

The default value for an unsigned integer field. Optional.

\n " } }, "documentation": "\n

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

\n " }, "LiteralOptions": { "shape_name": "LiteralOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a literal field. Optional.

\n " }, "SearchEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether search is enabled for this field. Default: False.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " } }, "documentation": "\n

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

\n " }, "TextOptions": { "shape_name": "TextOptions", "type": "structure", "members": { "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value for a text field. Optional.

\n " }, "FacetEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether facets are enabled for this field. Default: False.

\n " }, "ResultEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

\n " }, "TextProcessor": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The text processor to apply to this field. Optional. Possible values:

\n \n

Default: none

\n " } }, "documentation": "\n

Options for text field. Present if IndexFieldType specifies the field is of type text.

\n " }, "SourceAttributes": { "shape_name": "SourceAttributeList", "type": "list", "members": { "shape_name": "SourceAttribute", "type": "structure", "members": { "SourceDataFunction": { "shape_name": "SourceDataFunction", "type": "string", "enum": [ "Copy", "TrimTitle", "Map" ], "documentation": "\n

Identifies the transformation to apply when copying data from a source attribute.

\n ", "required": true }, "SourceDataCopy": { "shape_name": "SourceData", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " } }, "documentation": "\n

Copies data from a source document attribute to an IndexField.

\n " }, "SourceDataTrimTitle": { "shape_name": "SourceDataTrimTitle", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Separator": { "shape_name": "String", "type": "string", "documentation": "\n

The separator that follows the text to trim.

\n " }, "Language": { "shape_name": "Language", "type": "string", "pattern": "[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation": "\n

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

\n " } }, "documentation": "\n

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

\n " }, "SourceDataMap": { "shape_name": "SourceDataMap", "type": "structure", "members": { "SourceName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the document source field to add to this IndexField.

\n ", "required": true }, "DefaultValue": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The default value to use if the source attribute is not specified in a document. Optional.

\n " }, "Cases": { "shape_name": "StringCaseMap", "type": "map", "keys": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "members": { "shape_name": "FieldValue", "type": "string", "min_length": 0, "max_length": 1024, "documentation": "\n

The value of a field or source document attribute.

\n " }, "documentation": "\n

A map that translates source field values to custom values.

\n " } }, "documentation": "\n

Maps source document attribute values to new values when populating the IndexField.

\n " } }, "documentation": "\n

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

\n " }, "documentation": "\n

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

\n " } }, "documentation": "\n

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of an IndexField and its current status.

\n " }, "documentation": "\n

The index fields configured for the domain.

\n ", "required": true } }, "documentation": "\n

A response message that contains the index fields for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

\n " }, "DescribeRankExpressions": { "name": "DescribeRankExpressions", "input": { "shape_name": "DescribeRankExpressionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "RankNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

A string that represents the name of an index field. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n\n " }, "documentation": "\n

Limits the DescribeRankExpressions response to the specified fields.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeRankExpressionsResponse", "type": "structure", "members": { "RankExpressions": { "shape_name": "RankExpressionStatusList", "type": "list", "members": { "shape_name": "RankExpressionStatus", "type": "structure", "members": { "Options": { "shape_name": "NamedRankExpression", "type": "structure", "members": { "RankName": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n ", "required": true }, "RankExpression": { "shape_name": "RankExpression", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\n

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

\n\n\n

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

\n

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

\n

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

\n ", "required": true } }, "documentation": "\n

The expression that is evaluated for ranking or thresholding while processing a search request.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of a RankExpression and its current status.

\n " }, "documentation": "\n

The rank expressions configured for the domain.

\n ", "required": true } }, "documentation": "\n

A response message that contains the rank expressions for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

\n " }, "DescribeServiceAccessPolicies": { "name": "DescribeServiceAccessPolicies", "input": { "shape_name": "DescribeServiceAccessPoliciesRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeServiceAccessPoliciesResponse", "type": "structure", "members": { "AccessPolicies": { "shape_name": "AccessPoliciesStatus", "type": "structure", "members": { "Options": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\n

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

\n

Example: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

\n ", "required": true } }, "documentation": "\n

A response message that contains the access policies for a domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets information about the resource-based policies that control access to the domain's document and search services.

\n " }, "DescribeStemmingOptions": { "name": "DescribeStemmingOptions", "input": { "shape_name": "DescribeStemmingOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStemmingOptionsResponse", "type": "structure", "members": { "Stems": { "shape_name": "StemmingOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StemsDocument", "type": "string", "documentation": "\n

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The stemming options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the stemming options for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets the stemming dictionary configured for the search domain.

\n " }, "DescribeStopwordOptions": { "name": "DescribeStopwordOptions", "input": { "shape_name": "DescribeStopwordOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStopwordOptionsResponse", "type": "structure", "members": { "Stopwords": { "shape_name": "StopwordOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StopwordsDocument", "type": "string", "documentation": "\n

Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The stopword options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the stopword options for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets the stopwords configured for the search domain.

\n " }, "DescribeSynonymOptions": { "name": "DescribeSynonymOptions", "input": { "shape_name": "DescribeSynonymOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeSynonymOptionsResponse", "type": "structure", "members": { "Synonyms": { "shape_name": "SynonymOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "SynonymsDocument", "type": "string", "documentation": "\n

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The synonym options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the synonym options for a search domain.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Gets the synonym dictionary configured for the search domain.

\n " }, "IndexDocuments": { "name": "IndexDocuments", "input": { "shape_name": "IndexDocumentsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "IndexDocumentsResponse", "type": "structure", "members": { "FieldNames": { "shape_name": "FieldNameList", "type": "list", "members": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

A string that represents the name of an index field. Field names must begin with a letter and can contain the following\n characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

\n\n " }, "documentation": "\n

The names of the fields that are currently being processed due to an IndexDocuments action.

\n " } }, "documentation": "\n

The result of an IndexDocuments action.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

\n " }, "UpdateDefaultSearchField": { "name": "UpdateDefaultSearchField", "input": { "shape_name": "UpdateDefaultSearchFieldRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "DefaultSearchField": { "shape_name": "String", "type": "string", "documentation": "\n

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "UpdateDefaultSearchFieldResponse", "type": "structure", "members": { "DefaultSearchField": { "shape_name": "DefaultSearchFieldStatus", "type": "structure", "members": { "Options": { "shape_name": "FieldName", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[a-z][a-z0-9_]*", "documentation": "\n

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The value of the DefaultSearchField configured for this search domain and its current status.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of an updated default search field.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures the default search field for the search domain. The default search field is used when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

\n " }, "UpdateServiceAccessPolicies": { "name": "UpdateServiceAccessPolicies", "input": { "shape_name": "UpdateServiceAccessPoliciesRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "AccessPolicies": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\n

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

\n

Example: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "UpdateServiceAccessPoliciesResponse", "type": "structure", "members": { "AccessPolicies": { "shape_name": "AccessPoliciesStatus", "type": "structure", "members": { "Options": { "shape_name": "PolicyDocument", "type": "string", "documentation": "\n

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

\n

Example: {\"Statement\": [{\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:search/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }},\n {\"Effect\":\"Allow\",\n \"Action\": \"*\",\n \"Resource\":\n \"arn:aws:cs:us-east-1:1234567890:documents/movies\",\n \"Condition\": \n { \"IpAddress\": { aws:SourceIp\": [\"203.0.113.1/32\"] }\n }}\n ]\n}

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of updated access policies.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " } ], "documentation": "\n

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.

\n " }, "UpdateStemmingOptions": { "name": "UpdateStemmingOptions", "input": { "shape_name": "UpdateStemmingOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Stems": { "shape_name": "StemsDocument", "type": "string", "documentation": "\n

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "UpdateStemmingOptionsResponse", "type": "structure", "members": { "Stems": { "shape_name": "StemmingOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StemsDocument", "type": "string", "documentation": "\n

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The stemming options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of updated stemming options.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.

\n " }, "UpdateStopwordOptions": { "name": "UpdateStopwordOptions", "input": { "shape_name": "UpdateStopwordOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Stopwords": { "shape_name": "StopwordsDocument", "type": "string", "documentation": "\n

Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "UpdateStopwordOptionsResponse", "type": "structure", "members": { "Stopwords": { "shape_name": "StopwordOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "StopwordsDocument", "type": "string", "documentation": "\n

Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The stopword options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of updated stopword options.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.

\n \n " }, "UpdateSynonymOptions": { "name": "UpdateSynonymOptions", "input": { "shape_name": "UpdateSynonymOptionsRequest", "type": "structure", "members": { "DomainName": { "shape_name": "DomainName", "type": "string", "min_length": 3, "max_length": 28, "pattern": "[a-z][a-z0-9\\-]+", "documentation": "\n

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

\n\n ", "required": true }, "Synonyms": { "shape_name": "SynonymsDocument", "type": "string", "documentation": "\n

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "UpdateSynonymOptionsResponse", "type": "structure", "members": { "Synonyms": { "shape_name": "SynonymOptionsStatus", "type": "structure", "members": { "Options": { "shape_name": "SynonymsDocument", "type": "string", "documentation": "\n

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }

\n ", "required": true }, "Status": { "shape_name": "OptionStatus", "type": "structure", "members": { "CreationDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was created.

\n ", "required": true }, "UpdateDate": { "shape_name": "UpdateTimestamp", "type": "timestamp", "documentation": "\n

A timestamp for when this option was last updated.

\n ", "required": true }, "UpdateVersion": { "shape_name": "UIntValue", "type": "integer", "min_length": 0, "documentation": "\n

A unique integer that indicates when this option was last updated.

\n " }, "State": { "shape_name": "OptionState", "type": "string", "enum": [ "RequiresIndexDocuments", "Processing", "Active" ], "documentation": "\n

The state of processing a change to an option. Possible values:

\n\n ", "required": true }, "PendingDeletion": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the option will be deleted once processing is complete.

\n " } }, "documentation": "\n

The status of an option, including when it was last updated and whether it is actively in use for searches.

\n ", "required": true } }, "documentation": "\n

The synonym options configured for this search domain and the current status of those options.

\n ", "required": true } }, "documentation": "\n

A response message that contains the status of updated synonym options.

\n " }, "errors": [ { "shape_name": "BaseException", "type": "structure", "members": { "Code": { "shape_name": "ErrorCode", "type": "string", "documentation": "\n

A machine-parsable string error or warning code.

\n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

A human-readable string error or warning message.

\n " } }, "documentation": "\n

An error occurred while processing the request.

\n " }, { "shape_name": "InternalException", "type": "structure", "members": {}, "documentation": "\n

An internal error occurred while processing the request. If this problem persists,\n report an issue from the Service Health Dashboard.

\n " }, { "shape_name": "InvalidTypeException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it specified an invalid type definition.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because a resource limit has already been met.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The request was rejected because it attempted to reference a resource that does not exist.

\n " } ], "documentation": "\n

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

\n " } }, "metadata": { "regions": { "us-east-1": null, "us-west-1": null, "us-west-2": null, "eu-west-1": null, "ap-southeast-1": null }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "BandwidthLimitExceeded", "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/cloudtrail.json0000644000175000017500000012373612254746566021321 0ustar takakitakaki{ "api_version": "2013-11-01", "type": "json", "json_version": 1.1, "target_prefix": "com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", "signature_version": "v4", "service_full_name": "AWS CloudTrail", "service_abbreviation": "CloudTrail", "endpoint_prefix": "cloudtrail", "xmlnamespace": "http://cloudtrail.amazonaws.com/doc/2013-11-01/", "documentation": "\n AWS Cloud Trail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

\n \n \n \n As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code \n for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically \n signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.\n \n \n \n

See the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

", "operations": { "CreateTrail": { "name": "CreateTrail", "input": { "shape_name": "CreateTrailRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the trail.

\n \n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon S3 bucket designated for publishing log files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the trail is publishing events from global services such as IAM to the log files.

\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the trail set by calling CreateTrail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Value of the Amazon S3 prefix.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

\n " } }, "documentation": "\n

Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.

\n " } }, "documentation": "\n

Specifies the settings for each trail.

\n " }, "output": { "shape_name": "CreateTrailResponse", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the trail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon S3 bucket designated for publishing log files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the trail is publishing events from global services such as IAM to the log files.

\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the trail set by calling CreateTrail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Value of the Amazon S3 prefix.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

\n " } }, "documentation": "\n

Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.

\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " }, "errors": [ { "shape_name": "MaximumNumberOfTrailsExceededException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the maximum number of trails is reached.\n\t" }, { "shape_name": "TrailAlreadyExistsException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified trail already exists.\n\t" }, { "shape_name": "S3BucketDoesNotExistException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t" }, { "shape_name": "InsufficientS3BucketPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t" }, { "shape_name": "InsufficientSnsTopicPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t" }, { "shape_name": "InvalidS3BucketNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t" }, { "shape_name": "InvalidS3PrefixException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t" }, { "shape_name": "InvalidSnsTopicNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" }, { "shape_name": "TrailNotProvidedException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], "documentation": "\n

From the command line, use create-subscription.

\n

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

\n \n Support for passing Trail as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n \n \n \n " }, "DeleteTrail": { "name": "DeleteTrail", "input": { "shape_name": "DeleteTrailRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of a trail to be deleted.

\n ", "required": true } }, "documentation": "\n The request that specifies the name of a trail to delete.\n " }, "output": { "shape_name": "DeleteTrailResponse", "type": "structure", "members": {}, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\n

Deletes a trail.

\n " }, "DescribeTrails": { "name": "DescribeTrails", "input": { "shape_name": "DescribeTrailsRequest", "type": "structure", "members": { "trailNameList": { "shape_name": "TrailNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The list of trails.

\n " } }, "documentation": "\n

Returns the list of trails.

\n " }, "output": { "shape_name": "DescribeTrailsResponse", "type": "structure", "members": { "trailList": { "shape_name": "TrailList", "type": "list", "members": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the trail set by calling CreateTrail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Value of the Amazon S3 prefix.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

\n " } }, "documentation": "\n

The settings for a trail.

\n " }, "documentation": "\n

The list of trails.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [], "documentation": "\n

Retrieves the settings for some or all trails associated with an account.

\n " }, "GetTrailStatus": { "name": "GetTrailStatus", "input": { "shape_name": "GetTrailStatusRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the trail for which you are requesting the current status.

\n ", "required": true } }, "documentation": "\n

The name of a trail about which you want the current status.

\n " }, "output": { "shape_name": "GetTrailStatusResponse", "type": "structure", "members": { "IsLogging": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the CloudTrail is currently logging AWS API calls.

\n " }, "LatestDeliveryError": { "shape_name": "String", "type": "string", "documentation": "\n

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

\n " }, "LatestNotificationError": { "shape_name": "String", "type": "string", "documentation": "\n

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

\n " }, "LatestDeliveryTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

\n " }, "LatestNotificationTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

\n " }, "StartLoggingTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

\n " }, "StopLoggingTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

\n " }, "LatestDeliveryAttemptTime": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " }, "LatestNotificationAttemptTime": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " }, "LatestNotificationAttemptSucceeded": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " }, "LatestDeliveryAttemptSucceeded": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " }, "TimeLoggingStarted": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " }, "TimeLoggingStopped": { "shape_name": "String", "type": "string", "documentation": "\n

Scheduled for removal as early as February 15, 2014.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\n

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.

\n \n

The CloudTrail API is currently undergoing revision. This action currently returns both\n new fields and fields slated for removal from the API. The following lists indicate the\n plans for each field:

\n\n

List of Members Planned for Ongoing Support

\n\n\n

List of Members Scheduled for Removal

\n\n \n\n No replacements have been created for LatestDeliveryAttemptSucceeded and LatestNotificationAttemptSucceeded. Use LatestDeliveryError and LatestNotificationError to evaluate success or failure of log delivery or notification. Empty values returned for these fields indicate success. An error in LatestDeliveryError generally indicates either a missing bucket or insufficient permissions to write to the bucket. Similarly, an error in LatestNotificationError indicates either a missing topic or insufficient permissions. \n \n \n\n\n " }, "StartLogging": { "name": "StartLogging", "input": { "shape_name": "StartLoggingRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the trail for which CloudTrail logs AWS API calls.

\n ", "required": true } }, "documentation": "\n

The request to CloudTrail to start logging AWS API calls for an account.

\n " }, "output": { "shape_name": "StartLoggingResponse", "type": "structure", "members": {}, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\n

Starts the recording of AWS API calls and log file delivery for a trail.

\n " }, "StopLogging": { "name": "StopLogging", "input": { "shape_name": "StopLoggingRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Communicates to CloudTrail the name of the trail for which to stop logging AWS API calls.

\n ", "required": true } }, "documentation": "\n

Passes the request to CloudTrail to stop logging AWS API calls for the specified account.

\n " }, "output": { "shape_name": "StopLoggingResponse", "type": "structure", "members": {}, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], "documentation": "\n

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording.

\n " }, "UpdateTrail": { "name": "UpdateTrail", "input": { "shape_name": "UpdateTrailRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the trail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon S3 bucket designated for publishing log files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the trail is publishing events from global services such as IAM to the log files.

\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the trail set by calling CreateTrail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Value of the Amazon S3 prefix.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

\n " } }, "documentation": "\n

Support for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.

\n " } }, "documentation": "\n

Specifies settings to update for the trail.

\n " }, "output": { "shape_name": "UpdateTrailResponse", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the trail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon S3 bucket designated for publishing log files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon S3 key prefix that precedes the name of the bucket you have designated for log file delivery.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the trail is publishing events from global services such as IAM to the log files.

\n " }, "trail": { "shape_name": "Trail", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the trail set by calling CreateTrail.

\n " }, "S3BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

Value of the Amazon S3 prefix.

\n " }, "SnsTopicName": { "shape_name": "String", "type": "string", "documentation": "\n

Name of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.

\n " }, "IncludeGlobalServiceEvents": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

\n " } }, "documentation": "\n

Represents the CloudTrail settings that were updated by calling UpdateTrail.

\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " }, "errors": [ { "shape_name": "S3BucketDoesNotExistException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the specified S3 bucket does not exist.\n\t" }, { "shape_name": "InsufficientS3BucketPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the S3 bucket is not sufficient.\n\t" }, { "shape_name": "InsufficientSnsTopicPolicyException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the policy on the SNS topic is not sufficient.\n\t" }, { "shape_name": "TrailNotFoundException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the trail with the given name is not found.\n\t" }, { "shape_name": "InvalidS3BucketNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 bucket name is not valid.\n\t" }, { "shape_name": "InvalidS3PrefixException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided S3 prefix is not valid.\n\t" }, { "shape_name": "InvalidSnsTopicNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided SNS topic name is not valid.\n\t" }, { "shape_name": "InvalidTrailNameException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" }, { "shape_name": "TrailNotProvidedException", "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], "documentation": "\n

From the command line, use update-subscription.

\n

Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket.

\n \n \n Support for passing Trail as a parameter ends as early as February 25, 2014. The request and response examples in this topic show the use of parameters as well as a Trail object. Until Trail is removed, you can use either Trail or the parameter list. \n \n \n \n " } }, "metadata": { "regions": { "us-east-1": "https://cloudtrail.us-east-1.amazonaws.com", "us-west-2": "https://cloudtrail.us-west-2.amazonaws.com" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/cloudwatch.json0000644000175000017500000034203012254746566021302 0ustar takakitakaki{ "api_version": "2010-08-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon CloudWatch", "service_abbreviation": "CloudWatch", "endpoint_prefix": "monitoring", "xmlnamespace": "http://monitoring.amazonaws.com/doc/2010-08-01/", "documentation": "\n\t\t

This is the Amazon CloudWatch API Reference. This guide provides detailed\n\t\t\tinformation about Amazon CloudWatch actions, data types, parameters, and\n\t\t\terrors. For detailed information about Amazon CloudWatch features and their associated API calls,\n\t\t\tgo to the Amazon CloudWatch Developer Guide.\n\t\t

\n\t\t

Amazon CloudWatch is a web service that enables you to publish, monitor, and manage various metrics,\n\t\t\tas well as configure alarm actions based on data from metrics. For more information about this product\n\t\t\tgo to http://aws.amazon.com/cloudwatch.\n\t\t

\n\n\t\t

Use the following links to get started using the Amazon CloudWatch API Reference:

\n\t\t\n\t", "operations": { "DeleteAlarms": { "name": "DeleteAlarms", "input": { "shape_name": "DeleteAlarmsInput", "type": "structure", "members": { "AlarmNames": { "shape_name": "AlarmNames", "type": "list", "members": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 100, "documentation": "\n\t\t

\n\t\tA list of alarms to be deleted.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t" }, "output": null, "errors": [ { "shape_name": "ResourceNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe named resource does not exist.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tDeletes all specified alarms.\n\t\tIn the event of an error, no alarms are deleted.\n\t\t

\n\t" }, "DescribeAlarmHistory": { "name": "DescribeAlarmHistory", "input": { "shape_name": "DescribeAlarmHistoryInput", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the alarm.\n\t\t

\n\t" }, "HistoryItemType": { "shape_name": "HistoryItemType", "type": "string", "enum": [ "ConfigurationUpdate", "StateUpdate", "Action" ], "documentation": "\n\t\t

\n\t\tThe type of alarm histories to retrieve.\n\t\t

\n\t" }, "StartDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe starting date to retrieve alarm history.\n\t\t

\n\t" }, "EndDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe ending date to retrieve alarm history.\n\t\t

\n\t" }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n\t\t

\n\t\tThe maximum number of alarm history records to retrieve.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": { "shape_name": "DescribeAlarmHistoryOutput", "type": "structure", "members": { "AlarmHistoryItems": { "shape_name": "AlarmHistoryItems", "type": "list", "members": { "shape_name": "AlarmHistoryItem", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe descriptive name for the alarm.\n\t\t

\n\t" }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp for the alarm history item.\n\t\t

\n\t" }, "HistoryItemType": { "shape_name": "HistoryItemType", "type": "string", "enum": [ "ConfigurationUpdate", "StateUpdate", "Action" ], "documentation": "\n\t\t

\n\t\tThe type of alarm history item.\n\t\t

\n\t" }, "HistorySummary": { "shape_name": "HistorySummary", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tA human-readable summary of the alarm history.\n\t\t

\n\t" }, "HistoryData": { "shape_name": "HistoryData", "type": "string", "min_length": 1, "max_length": 4095, "documentation": "\n\t\t

\n\t\tMachine-readable data about the alarm in JSON format.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\t\tThe AlarmHistoryItem data type\n\t\t\tcontains descriptive information about\n\t\t\tthe history of a specific alarm.\n\t\t\tIf you call DescribeAlarmHistory,\n\t\t\tAmazon CloudWatch returns this data type as part of\n\t\t\tthe DescribeAlarmHistoryResult data type.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tA list of alarm histories in JSON format.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe output for the DescribeAlarmHistory action.\n\t\t

\n\t" }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe next token specified is invalid.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tRetrieves history for the specified alarm.\n\t\tFilter alarms by date range or item type.\n\t\tIf an alarm name is not specified,\n\t\tAmazon CloudWatch returns histories for\n\t\tall of the owner's alarms.\n\t\t

\n\t\t\n\t\tAmazon CloudWatch retains the history of an alarm\n\t\tfor two weeks, whether or not you delete the alarm.\n\t\t\n\t", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AlarmHistoryItems", "py_input_token": "next_token" } }, "DescribeAlarms": { "name": "DescribeAlarms", "input": { "shape_name": "DescribeAlarmsInput", "type": "structure", "members": { "AlarmNames": { "shape_name": "AlarmNames", "type": "list", "members": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 100, "documentation": "\n\t\t

\n\t\tA list of alarm names to retrieve information for.\n\t\t

\n\t" }, "AlarmNamePrefix": { "shape_name": "AlarmNamePrefix", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe alarm name prefix. AlarmNames cannot\n\t\tbe specified if this parameter is specified.\n\t\t

\n\t" }, "StateValue": { "shape_name": "StateValue", "type": "string", "enum": [ "OK", "ALARM", "INSUFFICIENT_DATA" ], "documentation": "\n\t\t

\n\t\tThe state value to be used in matching alarms.\n\t\t

\n\t" }, "ActionPrefix": { "shape_name": "ActionPrefix", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n\t\t

\n\t\tThe action name prefix.\n\t\t

\n\t" }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n\t\t

\n\t\tThe maximum number of alarm descriptions to retrieve.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": { "shape_name": "DescribeAlarmsOutput", "type": "structure", "members": { "MetricAlarms": { "shape_name": "MetricAlarms", "type": "list", "members": { "shape_name": "MetricAlarm", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the alarm.\n\t\t

\n\t" }, "AlarmArn": { "shape_name": "AlarmArn", "type": "string", "min_length": 1, "max_length": 1600, "documentation": "\n\t\t

\n\t\tThe Amazon Resource Name (ARN) of the alarm.\n\t\t

\n\t" }, "AlarmDescription": { "shape_name": "AlarmDescription", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe description for the alarm.\n\t\t

\n\t" }, "AlarmConfigurationUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp of the last update to the alarm configuration.\n\t\t

\n\t" }, "ActionsEnabled": { "shape_name": "ActionsEnabled", "type": "boolean", "documentation": "\n\t\t

\n\t\tIndicates whether actions should be executed\n\t\tduring any changes to the alarm's state.\n\t\t

\n\t" }, "OKActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an OK state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

\n\t" }, "AlarmActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an ALARM state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

\n\t" }, "InsufficientDataActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an INSUFFICIENT_DATA state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic or triggering an Auto Scaling policy.\n\t\t

\n\t" }, "StateValue": { "shape_name": "StateValue", "type": "string", "enum": [ "OK", "ALARM", "INSUFFICIENT_DATA" ], "documentation": "\n\t\t

\n\t\tThe state value for the alarm.\n\t\t

\n\t" }, "StateReason": { "shape_name": "StateReason", "type": "string", "min_length": 0, "max_length": 1023, "documentation": "\n\t\t

\n\t\tA human-readable explanation for the alarm's state.\n\t\t

\n\t" }, "StateReasonData": { "shape_name": "StateReasonData", "type": "string", "min_length": 0, "max_length": 4000, "documentation": "\n\t\t

\n\t\tAn explanation for the alarm's state in machine-readable JSON format\n\t\t

\n\t" }, "StateUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp of the last update to the alarm's state.\n\t\t

\n\t" }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the alarm's metric.\n\t\t

\n\t" }, "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace of alarm's associated metric.\n\t\t

\n\t" }, "Statistic": { "shape_name": "Statistic", "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "documentation": "\n\t\t

\n\t\tThe statistic to apply to the alarm's associated metric.\n\t\t

\n\t" }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tThe list of dimensions associated with the alarm's associated metric.\n\t\t

\n\t" }, "Period": { "shape_name": "Period", "type": "integer", "min_length": 60, "documentation": "\n\t\t

\n\t\tThe period in seconds over which the statistic is applied.\n\t\t

\n\t" }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe unit of the alarm's associated metric.\n\t\t

\n\t" }, "EvaluationPeriods": { "shape_name": "EvaluationPeriods", "type": "integer", "min_length": 1, "documentation": "\n\t\t

\n\t\tThe number of periods over which data is compared to the\n\t\tspecified threshold.\n\t\t

\n\t" }, "Threshold": { "shape_name": "Threshold", "type": "double", "documentation": "\n\t\t

\n\t\tThe value against which the specified statistic is compared.\n\t\t

\n\t" }, "ComparisonOperator": { "shape_name": "ComparisonOperator", "type": "string", "enum": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "documentation": "\n\t\t

\n\t\tThe arithmetic operation to use when comparing the specified\n\t\tStatistic and Threshold. The specified\n\t\tStatistic value is used as the first operand.\n\t\t

\n\t" } }, "member_order": [ "AlarmName", "AlarmArn", "AlarmDescription", "AlarmConfigurationUpdatedTimestamp", "ActionsEnabled", "OKActions", "AlarmActions", "InsufficientDataActions", "StateValue", "StateReason", "StateReasonData", "StateUpdatedTimestamp", "MetricName", "Namespace", "Statistic", "Dimensions", "Period", "Unit", "EvaluationPeriods", "Threshold", "ComparisonOperator" ], "documentation": "\n\t\t

\n\t\tThe MetricAlarm data type represents\n\t\tan alarm. You can use PutMetricAlarm\n\t\tto create or update an alarm.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tA list of information for the specified alarms.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe output for the DescribeAlarms action.\n\t\t

\n\t" }, "errors": [ { "shape_name": "InvalidNextToken", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe next token specified is invalid.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tRetrieves alarms with the specified names.\n\t\tIf no name is specified, all alarms for the user are returned.\n\t\tAlarms can be retrieved by using only a prefix for the alarm name,\n\t\tthe alarm state, or a prefix for any action.\n\t\t

\n\t", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "MetricAlarms", "py_input_token": "next_token" } }, "DescribeAlarmsForMetric": { "name": "DescribeAlarmsForMetric", "input": { "shape_name": "DescribeAlarmsForMetricInput", "type": "structure", "members": { "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the metric.\n\t\t

\n\t", "required": true }, "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace of the metric.\n\t\t

\n\t", "required": true }, "Statistic": { "shape_name": "Statistic", "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "documentation": "\n\t\t

\n\t\tThe statistic for the metric.\n\t\t

\n\t" }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tThe list of dimensions associated with the metric.\n\t\t

\n\t" }, "Period": { "shape_name": "Period", "type": "integer", "min_length": 60, "documentation": "\n\t\t

\n\t\tThe period in seconds over which the statistic is applied.\n\t\t

\n\t" }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe unit for the metric.\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": { "shape_name": "DescribeAlarmsForMetricOutput", "type": "structure", "members": { "MetricAlarms": { "shape_name": "MetricAlarms", "type": "list", "members": { "shape_name": "MetricAlarm", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the alarm.\n\t\t

\n\t" }, "AlarmArn": { "shape_name": "AlarmArn", "type": "string", "min_length": 1, "max_length": 1600, "documentation": "\n\t\t

\n\t\tThe Amazon Resource Name (ARN) of the alarm.\n\t\t

\n\t" }, "AlarmDescription": { "shape_name": "AlarmDescription", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe description for the alarm.\n\t\t

\n\t" }, "AlarmConfigurationUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp of the last update to the alarm configuration.\n\t\t

\n\t" }, "ActionsEnabled": { "shape_name": "ActionsEnabled", "type": "boolean", "documentation": "\n\t\t

\n\t\tIndicates whether actions should be executed\n\t\tduring any changes to the alarm's state.\n\t\t

\n\t" }, "OKActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an OK state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

\n\t" }, "AlarmActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an ALARM state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic and triggering an Auto Scaling policy.\n\t\t

\n\t" }, "InsufficientDataActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an INSUFFICIENT_DATA state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only actions supported are publishing\n\t\tto an Amazon SNS topic or triggering an Auto Scaling policy.\n\t\t

\n\t" }, "StateValue": { "shape_name": "StateValue", "type": "string", "enum": [ "OK", "ALARM", "INSUFFICIENT_DATA" ], "documentation": "\n\t\t

\n\t\tThe state value for the alarm.\n\t\t

\n\t" }, "StateReason": { "shape_name": "StateReason", "type": "string", "min_length": 0, "max_length": 1023, "documentation": "\n\t\t

\n\t\tA human-readable explanation for the alarm's state.\n\t\t

\n\t" }, "StateReasonData": { "shape_name": "StateReasonData", "type": "string", "min_length": 0, "max_length": 4000, "documentation": "\n\t\t

\n\t\tAn explanation for the alarm's state in machine-readable JSON format\n\t\t

\n\t" }, "StateUpdatedTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp of the last update to the alarm's state.\n\t\t

\n\t" }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the alarm's metric.\n\t\t

\n\t" }, "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace of alarm's associated metric.\n\t\t

\n\t" }, "Statistic": { "shape_name": "Statistic", "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "documentation": "\n\t\t

\n\t\tThe statistic to apply to the alarm's associated metric.\n\t\t

\n\t" }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tThe list of dimensions associated with the alarm's associated metric.\n\t\t

\n\t" }, "Period": { "shape_name": "Period", "type": "integer", "min_length": 60, "documentation": "\n\t\t

\n\t\tThe period in seconds over which the statistic is applied.\n\t\t

\n\t" }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe unit of the alarm's associated metric.\n\t\t

\n\t" }, "EvaluationPeriods": { "shape_name": "EvaluationPeriods", "type": "integer", "min_length": 1, "documentation": "\n\t\t

\n\t\tThe number of periods over which data is compared to the\n\t\tspecified threshold.\n\t\t

\n\t" }, "Threshold": { "shape_name": "Threshold", "type": "double", "documentation": "\n\t\t

\n\t\tThe value against which the specified statistic is compared.\n\t\t

\n\t" }, "ComparisonOperator": { "shape_name": "ComparisonOperator", "type": "string", "enum": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "documentation": "\n\t\t

\n\t\tThe arithmetic operation to use when comparing the specified\n\t\tStatistic and Threshold. The specified\n\t\tStatistic value is used as the first operand.\n\t\t

\n\t" } }, "member_order": [ "AlarmName", "AlarmArn", "AlarmDescription", "AlarmConfigurationUpdatedTimestamp", "ActionsEnabled", "OKActions", "AlarmActions", "InsufficientDataActions", "StateValue", "StateReason", "StateReasonData", "StateUpdatedTimestamp", "MetricName", "Namespace", "Statistic", "Dimensions", "Period", "Unit", "EvaluationPeriods", "Threshold", "ComparisonOperator" ], "documentation": "\n\t\t

\n\t\tThe MetricAlarm data type represents\n\t\tan alarm. You can use PutMetricAlarm\n\t\tto create or update an alarm.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tA list of information for each alarm with the specified metric.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe output for the DescribeAlarmsForMetric action.\n\t\t

\n\t" }, "errors": [], "documentation": "\n\t\t

\n\t\tRetrieves all alarms for a single metric.\n\t\tSpecify a statistic, period, or unit to filter\n\t\tthe set of alarms further.\n\t\t

\n\t" }, "DisableAlarmActions": { "name": "DisableAlarmActions", "input": { "shape_name": "DisableAlarmActionsInput", "type": "structure", "members": { "AlarmNames": { "shape_name": "AlarmNames", "type": "list", "members": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 100, "documentation": "\n\t\t

\n\t\tThe names of the alarms to disable actions for.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t\t

\n\n\t\t

\n\t" }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tDisables actions for the specified alarms.\n\t\tWhen an alarm's actions are disabled the\n\t\talarm's state may change, but none of the\n\t\talarm's actions will execute.\n\t\t

\n\t" }, "EnableAlarmActions": { "name": "EnableAlarmActions", "input": { "shape_name": "EnableAlarmActionsInput", "type": "structure", "members": { "AlarmNames": { "shape_name": "AlarmNames", "type": "list", "members": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 100, "documentation": "\n\t\t

\n\t\tThe names of the alarms to enable actions for.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t" }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tEnables actions for the specified alarms.\n\t\t

\n\t" }, "GetMetricStatistics": { "name": "GetMetricStatistics", "input": { "shape_name": "GetMetricStatisticsInput", "type": "structure", "members": { "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace of the metric.\n\t\t

\n\t", "required": true }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the metric.\n\t\t

\n\t", "required": true }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tA list of dimensions describing qualities of the metric.\n\t\t

\n\t" }, "StartTime": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp to use for determining the first datapoint to return.\n\t\tThe value specified is inclusive; results include datapoints\n\t\twith the time stamp specified.\n\t\t

\n\t\t\n\t\tThe specified start time is rounded down to the nearest value.\n\t\tDatapoints are returned for start times up to two weeks in the past.\n\t\tSpecified start times that are more than two weeks in the past\n\t\twill not return datapoints for metrics that are\n\t\tolder than two weeks.\n\t\t\n\t", "required": true }, "EndTime": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp to use for determining the last\n\t\tdatapoint to return. The value specified is exclusive;\n\t\tresults will include datapoints up to the time stamp\n\t\tspecified.\n\t\t

\n\t", "required": true }, "Period": { "shape_name": "Period", "type": "integer", "min_length": 60, "documentation": "\n\t\t

\n\t\tThe granularity, in seconds, of the returned datapoints.\n\t\tPeriod must be at least 60 seconds and\n\t\tmust be a multiple of 60. The default value is 60.\n\t\t

\n\t", "required": true }, "Statistics": { "shape_name": "Statistics", "type": "list", "members": { "shape_name": "Statistic", "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "documentation": null }, "min_length": 1, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe metric statistics to return.\n\t\t

\n\t", "required": true }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe unit for the metric.\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": { "shape_name": "GetMetricStatisticsOutput", "type": "structure", "members": { "Label": { "shape_name": "MetricLabel", "type": "string", "documentation": "\n\t\t

\n\t\tA label describing the specified metric.\n\t\t

\n\t" }, "Datapoints": { "shape_name": "Datapoints", "type": "list", "members": { "shape_name": "Datapoint", "type": "structure", "members": { "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\tThe time stamp used for the datapoint.\n\t\t

\n\t" }, "SampleCount": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\tThe number of metric values that contributed to the aggregate value\n\t\tof this datapoint.\n\t\t

\n\t" }, "Average": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\tThe average of metric values that correspond to the datapoint.\n\t\t

\n\t" }, "Sum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\tThe sum of metric values used for the datapoint.\n\t\t

\n\t" }, "Minimum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\tThe minimum metric value used for the datapoint.\n\t\t

\n\t" }, "Maximum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\tThe maximum of the metric value used for the datapoint.\n\t\t

\n\t" }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe standard unit used for the datapoint.\n\t\t

\n\t" } }, "member_order": [ "Timestamp", "SampleCount", "Average", "Sum", "Minimum", "Maximum", "Unit" ], "documentation": "\n\t\t

\n\t\tThe Datapoint data type encapsulates the statistical data\n\t\tthat Amazon CloudWatch computes from metric data.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tThe datapoints for the specified metric.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe output for the GetMetricStatistics action.\n\t\t

\n\t" }, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

\n\t" }, { "shape_name": "MissingRequiredParameterException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tAn input parameter that is mandatory for processing\n\t\tthe request is not supplied.\n\t\t

\n\t" }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tParameters that must not be used together were\n\t\tused together.\n\t\t

\n\t" }, { "shape_name": "InternalServiceFault", "type": "structure", "members": { "Message": { "shape_name": "FaultDescription", "type": "string", "documentation": "\n\t\t

\n\t" } }, "member_order": [ "Message" ], "documentation": "\n\t\t

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tGets statistics for the specified metric.\n\t

\n\t\n\tThe maximum number of data points returned from a single\n\t GetMetricStatistics request is 1,440.\n\t If a request is made that generates more than 1,440 data points,\n\t Amazon CloudWatch returns an error. In such a case,\n\t alter the request by narrowing the specified time range\n\t or increasing the specified period. Alternatively,\n\t make multiple requests across adjacent time ranges.\n\t\n\t

\n\t\tAmazon CloudWatch aggregates data points based on the\n\t\tlength of the period that you specify.\n\t\tFor example, if you request statistics with a one-minute granularity,\n\t\tAmazon CloudWatch aggregates data points with time stamps that fall\n\t\twithin the same one-minute period. In such a case,\n\t\tthe data points queried can greatly outnumber the data points returned.\n\t

\n\t\t\n\t\tThe maximum number of data points that can be queried is 50,850;\n\t\twhereas the maximum number of data points returned is 1,440.\n\t\t\n\n\t\t

\n\t\tThe following examples show various statistics allowed by the data point query maximum of 50,850\n\t\twhen you call GetMetricStatistics on Amazon EC2 instances with\n\t\tdetailed (one-minute) monitoring enabled:\n\t\t

\n\t\t\n\n\t" }, "ListMetrics": { "name": "ListMetrics", "input": { "shape_name": "ListMetricsInput", "type": "structure", "members": { "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace to filter against.\n\t\t

\n\t" }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the metric to filter against.\n\t\t

\n\t" }, "Dimensions": { "shape_name": "DimensionFilters", "type": "list", "members": { "shape_name": "DimensionFilter", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe dimension name to be matched.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value of the dimension to be matched.\n\t\t

\n\t\t\n\t\tSpecifying a Name without specifying a\n\t\tValue returns all values associated\n\t\twith that Name.\n\t\t\n\t" } }, "documentation": "\n\t\t

\n\t\tThe DimensionFilter data type is used to filter\n\t\tListMetrics results.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tA list of dimensions to filter against.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tThe token returned by a previous call to indicate that there\n\t\tis more data available.\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": { "shape_name": "ListMetricsOutput", "type": "structure", "members": { "Metrics": { "shape_name": "Metrics", "type": "list", "members": { "shape_name": "Metric", "type": "structure", "members": { "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace of the metric.\n\t\t

\n\t" }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the metric.\n\t\t

\n\t" }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tA list of dimensions associated with the metric.\n\t\t

\n\t" } }, "member_order": [ "Namespace", "MetricName", "Dimensions" ], "documentation": "\n\t\t

\n\t\tThe Metric data type contains\n\t\tinformation about a specific metric. If you call\n\t\tListMetrics, Amazon CloudWatch returns\n\t\tinformation contained by this data type.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tA list of metrics used to generate statistics for an AWS account.\n\t\t

\n\t" }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t\t

\n\t\tA string that marks the start of the next batch of returned results.\n\t\t

\n\t" } }, "member_order": [ "Metrics", "NextToken" ], "documentation": "\n\t\t

\n\t\tThe output for the ListMetrics action.\n\t\t

\n\t" }, "errors": [ { "shape_name": "InternalServiceFault", "type": "structure", "members": { "Message": { "shape_name": "FaultDescription", "type": "string", "documentation": "\n\t\t

\n\t" } }, "member_order": [ "Message" ], "documentation": "\n\t\t

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

\n\t" }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tReturns a list of valid metrics stored for the AWS account owner.\n\t\tReturned metrics can be used with GetMetricStatistics\n\t\tto obtain statistical data for a given metric.\n\t\t

\n\t\t\n\t\tUp to 500 results are returned for any one call. To retrieve further\n\t\tresults, use returned NextToken values with subsequent\n\t\tListMetrics operations.\n\t\t\n\t\t\n\t\t\tIf you create a metric with the PutMetricData action,\n\t\t\tallow up to fifteen minutes for the metric to appear in calls\n\t\t\tto the ListMetrics action.\n\t\t\n\t", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Metrics", "py_input_token": "next_token" } }, "PutMetricAlarm": { "name": "PutMetricAlarm", "input": { "shape_name": "PutMetricAlarmInput", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe descriptive name for the alarm. This name\n\t\tmust be unique within the user's AWS account\n\t\t

\n\t", "required": true }, "AlarmDescription": { "shape_name": "AlarmDescription", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe description for the alarm.\n\t\t

\n\t" }, "ActionsEnabled": { "shape_name": "ActionsEnabled", "type": "boolean", "documentation": "\n\t\t

\n\t\tIndicates whether or not actions should be executed\n\t\tduring any changes to the alarm's state.\n\t\t

\n\t" }, "OKActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an OK state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

\n\t" }, "AlarmActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an ALARM state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

\n\t" }, "InsufficientDataActions": { "shape_name": "ResourceList", "type": "list", "members": { "shape_name": "ResourceName", "type": "string", "min_length": 1, "max_length": 1024, "documentation": null }, "max_length": 5, "documentation": "\n\t\t

\n\t\tThe list of actions to execute when this alarm\n\t\ttransitions into an INSUFFICIENT_DATA state\n\t\tfrom any other state. Each action is specified as an\n\t\tAmazon Resource Number (ARN).\n\t\tCurrently the only action supported is publishing\n\t\tto an Amazon SNS topic or an Amazon Auto Scaling policy.\n\t\t

\n\t" }, "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name for the alarm's associated metric.\n\t\t

\n\t", "required": true }, "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace for the alarm's associated metric.\n\t\t

\n\t", "required": true }, "Statistic": { "shape_name": "Statistic", "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], "documentation": "\n\t\t

\n\t\tThe statistic to apply to the alarm's associated metric.\n\t\t

\n\t", "required": true }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\tThe dimensions for the alarm's associated metric.\n\t\t

\n\t" }, "Period": { "shape_name": "Period", "type": "integer", "min_length": 60, "documentation": "\n\t\t

\n\t\tThe period in seconds over which the specified statistic\n\t\tis applied.\n\t\t

\n\t", "required": true }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\tThe unit for the alarm's associated metric.\n\t\t

\n\t" }, "EvaluationPeriods": { "shape_name": "EvaluationPeriods", "type": "integer", "min_length": 1, "documentation": "\n\t\t

\n\t\tThe number of periods over which data is compared to the\n\t\tspecified threshold.\n\t\t

\n\t", "required": true }, "Threshold": { "shape_name": "Threshold", "type": "double", "documentation": "\n\t\t

\n\t\tThe value against which the specified statistic is compared.\n\t\t

\n\t", "required": true }, "ComparisonOperator": { "shape_name": "ComparisonOperator", "type": "string", "enum": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ], "documentation": "\n\t\t

\n\t\tThe arithmetic operation to use when comparing the specified\n\t\tStatistic and Threshold. The specified\n\t\tStatistic value is used as the first operand.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t" }, "output": null, "errors": [ { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe quota for alarms for this customer has\n\t\talready been reached.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tCreates or updates an alarm and associates it\n\t\twith the specified Amazon CloudWatch metric. Optionally,\n\t\tthis operation can associate one or more Amazon Simple\n\t\tNotification Service resources with the alarm.\n\t\t

\n\t\t

\n\t\tWhen this operation creates an alarm, the alarm state is immediately\n\t\tset to INSUFFICIENT_DATA. The alarm is evaluated and its\n\t\tStateValue is set appropriately. Any actions associated\n\t\twith the StateValue is then executed.\n\t\t

\n\t\t\n\t\tWhen updating an existing alarm, its StateValue\n\t\tis left unchanged.\n\t\t\n\t" }, "PutMetricData": { "name": "PutMetricData", "input": { "shape_name": "PutMetricDataInput", "type": "structure", "members": { "Namespace": { "shape_name": "Namespace", "type": "string", "pattern": "[^:].*", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe namespace for the metric data.\n\t\t

\n\t", "required": true }, "MetricData": { "shape_name": "MetricData", "type": "list", "members": { "shape_name": "MetricDatum", "type": "structure", "members": { "MetricName": { "shape_name": "MetricName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\t\tThe name of the metric.\n\t\t

\n\t", "required": true }, "Dimensions": { "shape_name": "Dimensions", "type": "list", "members": { "shape_name": "Dimension", "type": "structure", "members": { "Name": { "shape_name": "DimensionName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe name of the dimension.\n\t\t

\n\t", "required": true }, "Value": { "shape_name": "DimensionValue", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe value representing the dimension measurement\n\t\t

\n\t", "required": true } }, "member_order": [ "Name", "Value" ], "documentation": "\n\t\t

\n\t\tThe Dimension data type further expands on the\n\t\tidentity of a metric using a Name, Value pair.\n\t\t

\n\t" }, "max_length": 10, "documentation": "\n\t\t

\n\t\t\tA list of dimensions associated with the metric.\n\t\t

\n\t" }, "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n\t\t

\n\t\t\tThe time stamp used for the metric.\n\t\t\tIf not specified, the default value is set\n\t\t\tto the time the metric data was received.\n\t\t

\n\t" }, "Value": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\t\tThe value for the metric.\n\t\t

\n\t\tAlthough the Value parameter accepts numbers of type Double,\n\t\t\tAmazon CloudWatch truncates values with very large exponents.\n\t\t\tValues with base-10 exponents greater than 126 (1 x 10^126) are truncated.\n\t\t\tLikewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.\n\t\t\n\t" }, "StatisticValues": { "shape_name": "StatisticSet", "type": "structure", "members": { "SampleCount": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\t\tThe number of samples used for the statistic set.\n\t\t

\n\t", "required": true }, "Sum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\t\tThe sum of values for the sample set.\n\t\t

\n\t", "required": true }, "Minimum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\t\tThe minimum value of the sample set.\n\t\t

\n\t", "required": true }, "Maximum": { "shape_name": "DatapointValue", "type": "double", "documentation": "\n\t\t

\n\t\t\tThe maximum value of the sample set.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t\t

\n\t\t\tA set of statistical values describing the metric.\n\t\t

\n\t" }, "Unit": { "shape_name": "StandardUnit", "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], "documentation": "\n\t\t

\n\t\t\tThe unit of the metric.\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\t\tThe MetricDatum data type encapsulates the information\n\t\t\tsent with PutMetricData to either create a new metric or\n\t\t\tadd new values to be aggregated into an existing metric.\n\t\t

\n\t" }, "documentation": "\n\t\t

\n\t\tA list of data describing the metric.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t" }, "output": null, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tBad or out-of-range value was supplied for the input\n\t\tparameter.\n\t\t

\n\t" }, { "shape_name": "MissingRequiredParameterException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tAn input parameter that is mandatory for processing\n\t\tthe request is not supplied.\n\t\t

\n\t" }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tParameters that must not be used together were\n\t\tused together.\n\t\t

\n\t" }, { "shape_name": "InternalServiceFault", "type": "structure", "members": { "Message": { "shape_name": "FaultDescription", "type": "string", "documentation": "\n\t\t

\n\t" } }, "member_order": [ "Message" ], "documentation": "\n\t\t

\n\t\tIndicates that the request processing has\n\t\tfailed due to some unknown error, exception, or failure.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tPublishes metric data points to Amazon CloudWatch. Amazon Cloudwatch\n\t\tassociates the data points with the specified metric. If the specified metric does not exist,\n\t\tAmazon CloudWatch creates the metric.\n\t\t

\n\t\t\n\t\t\tIf you create a metric with the PutMetricData action,\n\t\t\tallow up to fifteen minutes for the metric to appear in calls\n\t\t\tto the ListMetrics action.\n\t\t\n\t\t

\n\t\t\tThe size of a PutMetricData request is limited to 8 KB\n\t\t\tfor HTTP GET requests and 40 KB for HTTP POST requests.\n\t\t

\n\t\t\n\t\t\tAlthough the Value parameter accepts numbers of type Double,\n\t\t\tAmazon CloudWatch truncates values with very large exponents.\n\t\t\tValues with base-10 exponents greater than 126 (1 x 10^126) are truncated.\n\t\t\tLikewise, values with base-10 exponents less than -130 (1 x 10^-130) are also truncated.\n\t\t\n\n\t" }, "SetAlarmState": { "name": "SetAlarmState", "input": { "shape_name": "SetAlarmStateInput", "type": "structure", "members": { "AlarmName": { "shape_name": "AlarmName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t\tThe descriptive name for the alarm. This name\n\t\tmust be unique within the user's AWS account.\n\t\tThe maximum length is 255 characters.\n\t\t

\n\t", "required": true }, "StateValue": { "shape_name": "StateValue", "type": "string", "enum": [ "OK", "ALARM", "INSUFFICIENT_DATA" ], "documentation": "\n\t\t

\n\t\t\tThe value of the state.\n\t\t

\n\t", "required": true }, "StateReason": { "shape_name": "StateReason", "type": "string", "min_length": 0, "max_length": 1023, "documentation": "\n\t\t

\n\t\tThe reason that this alarm is set to this specific state (in human-readable text format)\n\t\t

\n\t", "required": true }, "StateReasonData": { "shape_name": "StateReasonData", "type": "string", "min_length": 0, "max_length": 4000, "documentation": "\n\t\t

\n\t\tThe reason that this alarm is set to this specific state (in machine-readable JSON format)\n\t\t

\n\t" } }, "documentation": "\n\t" }, "output": null, "errors": [ { "shape_name": "ResourceNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tThe named resource does not exist.\n\t\t

\n\t" }, { "shape_name": "InvalidFormatFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n\t\t

\n\t" } }, "documentation": "\n\t\t

\n\t\tData was not syntactically valid JSON.\n\t\t

\n\t" } ], "documentation": "\n\t\t

\n\t\tTemporarily sets the state of an alarm.\n\t\tWhen the updated StateValue differs\n\t\tfrom the previous value, the action configured for\n\t\tthe appropriate state is invoked. This is not a\n\t\tpermanent change. The next periodic alarm check\n\t\t(in about a minute) will set the alarm to its actual state.\n\t\t

\n\t" } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://monitoring.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "DescribeAlarmHistory": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "AlarmHistoryItems", "py_input_token": "next_token" }, "DescribeAlarms": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "MetricAlarms", "py_input_token": "next_token" }, "ListMetrics": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Metrics", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/datapipeline.json0000644000175000017500000051004012254746564021600 0ustar takakitakaki{ "api_version": "2012-10-29", "type": "json", "json_version": 1.1, "target_prefix": "DataPipeline", "signature_version": "v4", "service_full_name": "AWS Data Pipeline", "endpoint_prefix": "datapipeline", "xmlnamespace": "http://datapipeline.amazonaws.com/doc/2012-10-29/", "documentation": "\n

\n This is the AWS Data Pipeline API Reference. This guide provides descriptions and\n samples of the AWS Data Pipeline API.\n

\n \n

\n AWS Data Pipeline is a web service that configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so your application can focus on processing the data.

\n \n

\n The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.\n

\n \n

\n The second set of actions are used by a task runner application that calls the AWS Data Pipeline API to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.\n

\n \n

\n AWS Data Pipeline provides an open-source implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.\n

\n \n \n

\n The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see \n Signature Version 4 Signing Process. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.\n

\n \n ", "operations": { "ActivatePipeline": { "name": "ActivatePipeline", "input": { "shape_name": "ActivatePipelineInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the pipeline to activate.

\n ", "required": true } }, "documentation": "\n

The input of the ActivatePipeline action.

\n " }, "output": { "shape_name": "ActivatePipelineOutput", "type": "structure", "members": {}, "documentation": "\n

Contains the output from the ActivatePipeline action.

\n " }, "errors": [ { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " }, { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

\n Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.\n

\n

\n Call this action to start processing pipeline tasks of a pipeline you've created using the CreatePipeline and PutPipelineDefinition actions. A pipeline cannot be modified after it has been successfully activated. \n

\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ActivatePipeline\nContent-Length: 39\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 2\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n \n \n " }, "CreatePipeline": { "name": "CreatePipeline", "input": { "shape_name": "CreatePipelineInput", "type": "structure", "members": { "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.\n

\n ", "required": true }, "uniqueId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

\n A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.\n

\n ", "required": true }, "description": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

The description of the new pipeline.

\n " } }, "documentation": "\n

The input for the CreatePipeline action.

\n " }, "output": { "shape_name": "CreatePipelineOutput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.

\n ", "required": true } }, "documentation": "\n

Contains the output from the CreatePipeline action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.CreatePipeline\nContent-Length: 91\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"name\": \"myPipeline\",\n \"uniqueId\": \"123456789\",\n \"description\": \"This is my first pipeline\"}\n \n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 40\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n \n \n \n \n " }, "DeletePipeline": { "name": "DeletePipeline", "input": { "shape_name": "DeletePipelineInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the pipeline to be deleted.

\n ", "required": true } }, "documentation": "\n

The input for the DeletePipeline action.

\n " }, "output": null, "errors": [ { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

\n Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.\n

\n

\n To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to Pause on individual components. Components that are paused by SetStatus can be resumed.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DeletePipeline\nContent-Length: 50\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \n \nx-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n \n \n " }, "DescribeObjects": { "name": "DescribeObjects", "input": { "shape_name": "DescribeObjectsInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the pipeline that contains the object definitions.

\n ", "required": true }, "objectIds": { "shape_name": "idList", "type": "list", "members": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": null }, "documentation": "\n

Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

\n ", "required": true }, "evaluateExpressions": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

\n " }, "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

The starting point for the results to be returned. The first time you call DescribeObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call DescribeObjects again and pass the marker value from the response to retrieve the next set of results.

\n " } }, "documentation": "\n

The DescribeObjects action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results.

\n " }, "output": { "shape_name": "DescribeObjectsOutput", "type": "structure", "members": { "pipelineObjects": { "shape_name": "PipelineObjectList", "type": "list", "members": { "shape_name": "PipelineObject", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the object.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the object.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

Key-value pairs that define the properties of the object.

\n ", "required": true } }, "documentation": "\n

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

\n " }, "documentation": "\n

An array of object definitions that are returned by the call to DescribeObjects.

\n ", "required": true }, "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

\n The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value.\n

\n " }, "hasMoreResults": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, there are more pages of results to return.

\n " } }, "documentation": "\n

If True, there are more results that can be returned in another call to DescribeObjects.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

\n Returns the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. \n

\n \n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribeObjects\nContent-Length: 98\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"objectIds\": \n [\"Schedule\"],\n \"evaluateExpressions\": true}\n\n \n \n \n\nx-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1488\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"COMPONENT\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"PENDING\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-06372391ZG65EXAMPLE\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}\n ]\n}\n \n \n \n \n " }, "DescribePipelines": { "name": "DescribePipelines", "input": { "shape_name": "DescribePipelinesInput", "type": "structure", "members": { "pipelineIds": { "shape_name": "idList", "type": "list", "members": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": null }, "documentation": "\n

Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to DescribePipelines. You can obtain pipeline identifiers by calling ListPipelines.

\n ", "required": true } }, "documentation": "\n

The input to the DescribePipelines action.

\n " }, "output": { "shape_name": "DescribePipelinesOutput", "type": "structure", "members": { "pipelineDescriptionList": { "shape_name": "PipelineDescriptionList", "type": "list", "members": { "shape_name": "PipelineDescription", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the pipeline.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

\n ", "required": true }, "description": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

Description of the pipeline.

\n " } }, "documentation": "\n

Contains pipeline metadata.

\n " }, "documentation": "\n

An array of descriptions returned for the specified pipelines.

\n ", "required": true } }, "documentation": "\n

Contains the output from the DescribePipelines action.

\n " }, "errors": [ { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " }, { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

\n Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.\n

\n

\n To retrieve the full pipeline definition instead of metadata about the pipeline, call the GetPipelineDefinition action.\n

\n \n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 70\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineIds\": \n [\"df-08785951KAKJEXAMPLE\"]\n}\n\n \n \n\n \n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 767\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineDescriptionList\": \n [\n {\"description\": \"This is my first pipeline\", \n \"fields\": \n [\n {\"key\": \"@pipelineState\", \n \"stringValue\": \"SCHEDULED\"}, \n {\"key\": \"description\", \n \"stringValue\": \"This is my first pipeline\"}, \n {\"key\": \"name\", \n \"stringValue\": \"myPipeline\"}, \n {\"key\": \"@creationTime\", \n \"stringValue\": \"2012-12-13T01:24:06\"}, \n {\"key\": \"@id\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"PIPELINE\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@userId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"@accountId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"uniqueId\", \n \"stringValue\": \"1234567890\"}\n ], \n \"name\": \"myPipeline\", \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\"}\n ]\n}\n\n \n \n " }, "EvaluateExpression": { "name": "EvaluateExpression", "input": { "shape_name": "EvaluateExpressionInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the pipeline.

\n ", "required": true }, "objectId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the object.

\n ", "required": true }, "expression": { "shape_name": "longString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 20971520, "documentation": "\n

The expression to evaluate.

\n ", "required": true } }, "documentation": "\n

The input for the EvaluateExpression action.

\n " }, "output": { "shape_name": "EvaluateExpressionOutput", "type": "structure", "members": { "evaluatedExpression": { "shape_name": "longString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 20971520, "documentation": "\n

The evaluated expression.

\n ", "required": true } }, "documentation": "\n

Contains the output from the EvaluateExpression action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "TaskNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified task was not found.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3.

\n \n \n \n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 164\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-08785951KAKJEXAMPLE\",\n \"objectId\": \"Schedule\",\n \"expression\": \"Transform started at #{startDateTime} and finished at #{endDateTime}\"}\n\n \n \n \n \n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 103\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"evaluatedExpression\": \"Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00\"}\n\n \n " }, "GetPipelineDefinition": { "name": "GetPipelineDefinition", "input": { "shape_name": "GetPipelineDefinitionInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the pipeline.

\n ", "required": true }, "version": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

The version of the pipeline definition to retrieve. This parameter accepts the values latest (default) and active. Where latest indicates the last definition saved to the pipeline and active indicates the last definition of the pipeline that was activated.

\n " } }, "documentation": "\n

The input for the GetPipelineDefinition action.

\n " }, "output": { "shape_name": "GetPipelineDefinitionOutput", "type": "structure", "members": { "pipelineObjects": { "shape_name": "PipelineObjectList", "type": "list", "members": { "shape_name": "PipelineObject", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the object.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the object.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

Key-value pairs that define the properties of the object.

\n ", "required": true } }, "documentation": "\n

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

\n " }, "documentation": "\n

An array of objects defined in the pipeline.

\n " } }, "documentation": "\n

Contains the output from the GetPipelineDefinition action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

Returns the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition you provided using PutPipelineDefinition.

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.GetPipelineDefinition\nContent-Length: 40\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n \n \n \nx-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 890\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ], \n \"id\": \"Default\", \n \"name\": \"Default\"}, \n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}, \n {\"fields\": \n [\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}\n ], \n \"id\": \"SayHello\", \n \"name\": \"SayHello\"}\n ]\n}\n\n \n \n " }, "ListPipelines": { "name": "ListPipelines", "input": { "shape_name": "ListPipelinesInput", "type": "structure", "members": { "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

The starting point for the results to be returned. The first time you call ListPipelines, this value should be empty. As long as the action returns HasMoreResults as True, you can call ListPipelines again and pass the marker value from the response to retrieve the next set of results.

\n " } }, "documentation": "\n

The input to the ListPipelines action.

\n " }, "output": { "shape_name": "ListPipelinesOutput", "type": "structure", "members": { "pipelineIdList": { "shape_name": "pipelineList", "type": "list", "members": { "shape_name": "PipelineIdName", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

\n " }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the pipeline.

\n " } }, "documentation": "\n

Contains the name and identifier of a pipeline.

\n " }, "documentation": "\n

\n A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.\n

\n ", "required": true }, "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

If not null, indicates the starting point for the set of pipeline identifiers that the next call to ListPipelines will retrieve. If null, there are no more pipeline identifiers.

\n " }, "hasMoreResults": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, there are more results that can be obtained by a subsequent call to ListPipelines.

\n " } }, "documentation": "\n

Contains the output from the ListPipelines action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ListPipelines\nContent-Length: 14\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{}\n\n \n \n \n \nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"PipelineIdList\": \n [\n {\"id\": \"df-08785951KAKJEXAMPLE\",\n \"name\": \"MyPipeline\"}, \n {\"id\": \"df-08662578ISYEXAMPLE\", \n \"name\": \"MySecondPipeline\"}\n ]\n} \n \n \n \n " }, "PollForTask": { "name": "PollForTask", "input": { "shape_name": "PollForTaskInput", "type": "structure", "members": { "workerGroup": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.\n

\n ", "required": true }, "hostname": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The public DNS name of the calling task runner.

\n " }, "instanceIdentity": { "shape_name": "InstanceIdentity", "type": "structure", "members": { "document": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

\n " }, "signature": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

\n " } }, "documentation": "\n

Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, http://169.254.169.254/latest/meta-data/instance-id, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

\n " } }, "documentation": "\n

The data type passed in as input to the PollForTask action.

\n " }, "output": { "shape_name": "PollForTaskOutput", "type": "structure", "members": { "taskObject": { "shape_name": "TaskObject", "type": "structure", "members": { "taskId": { "shape_name": "taskId", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 2048, "documentation": "\n

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

\n " }, "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the pipeline that provided the task.

\n " }, "attemptId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

\n " }, "objects": { "shape_name": "PipelineObjectMap", "type": "map", "keys": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": null }, "members": { "shape_name": "PipelineObject", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the object.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the object.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

Key-value pairs that define the properties of the object.

\n ", "required": true } }, "documentation": "\n

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

\n " }, "documentation": "\n

Connection information for the location where the task runner will publish the output of the task.

\n " } }, "documentation": "\n

An instance of PollForTaskResult, which contains an instance of TaskObject. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.

\n " } }, "documentation": "\n

Contains the output from the PollForTask action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "TaskNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified task was not found.

\n " } ], "documentation": "\n

\n Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.\n

\n

\n If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this may take up to 90 seconds.\n

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PollForTask\nContent-Length: 59\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"workerGroup\": \"MyworkerGroup\",\n \"hostname\": \"example.com\"}\n\n \n \n \n \nx-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"taskObject\": \n {\"attemptId\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"objects\": \n {\"@SayHello_2012-12-12T00:00:00_Attempt=1\": \n {\"fields\": \n [\n {\"key\": \"@componentParent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@scheduledStartTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"ATTEMPT\"}, \n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}, \n {\"key\": \"@instanceParent\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"WAITING_FOR_RUNNER\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"@actualStartTime\", \n \"stringValue\": \"2012-12-13T01:40:50\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"@scheduledEndTime\", \n \"stringValue\": \"2012-12-12T01:00:00\"}, \n {\"key\": \"@activeInstances\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}\n ], \n \"id\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"name\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\"}\n }, \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\", \n \"taskId\": \"2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1\"}\n}\n \n \n \n " }, "PutPipelineDefinition": { "name": "PutPipelineDefinition", "input": { "shape_name": "PutPipelineDefinitionInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the pipeline to be configured.

\n ", "required": true }, "pipelineObjects": { "shape_name": "PipelineObjectList", "type": "list", "members": { "shape_name": "PipelineObject", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the object.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the object.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

Key-value pairs that define the properties of the object.

\n ", "required": true } }, "documentation": "\n

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

\n " }, "documentation": "\n

The objects that define the pipeline. These will overwrite the existing pipeline definition.

\n ", "required": true } }, "documentation": "\n

The input of the PutPipelineDefinition action.

\n " }, "output": { "shape_name": "PutPipelineDefinitionOutput", "type": "structure", "members": { "validationErrors": { "shape_name": "ValidationErrors", "type": "list", "members": { "shape_name": "ValidationError", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the object that contains the validation error.

\n " }, "errors": { "shape_name": "validationMessages", "type": "list", "members": { "shape_name": "validationMessage", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10000, "documentation": null }, "documentation": "\n

A description of the validation error.

\n " } }, "documentation": "\n

Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

\n " }, "documentation": "\n

A list of the validation errors that are associated with the objects defined in pipelineObjects.

\n " }, "validationWarnings": { "shape_name": "ValidationWarnings", "type": "list", "members": { "shape_name": "ValidationWarning", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the object that contains the validation warning.

\n " }, "warnings": { "shape_name": "validationMessages", "type": "list", "members": { "shape_name": "validationMessage", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10000, "documentation": null }, "documentation": "\n

A description of the validation warning.

\n " } }, "documentation": "\n

Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

\n " }, "documentation": "\n

A list of the validation warnings that are associated with the objects defined in pipelineObjects.

\n " }, "errored": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, there were validation errors. If errored is True, the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

\n ", "required": true } }, "documentation": "\n

Contains the output of the PutPipelineDefinition action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline.\n

\n

\n PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.\n

    \n
  1. An object is missing a name or identifier field.
    2. \n
  2. A string or reference field is empty.
    3. \n
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
    4. \n
\n

\n

\n Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. \n

\n \n \n Example 1\n \n This example sets an valid pipeline configuration and returns success.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 914\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0937003356ZJEXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n ]\n }\n ]\n}\n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n\n \n \n \n \n Example 2\n \n This example sets an invalid pipeline configuration (the value for workerGroup is an empty string) and returns an error message.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"__type\": \"com.amazon.setl.webservice#InvalidRequestException\", \n \"message\": \"Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline\"}\n\n \n \n \n \n " }, "QueryObjects": { "name": "QueryObjects", "input": { "shape_name": "QueryObjectsInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the pipeline to be queried for object names.

\n ", "required": true }, "query": { "shape_name": "Query", "type": "structure", "members": { "selectors": { "shape_name": "SelectorList", "type": "list", "members": { "shape_name": "Selector", "type": "structure", "members": { "fieldName": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.

\n " }, "operator": { "shape_name": "Operator", "type": "structure", "members": { "type": { "shape_name": "OperatorType", "type": "string", "enum": [ "EQ", "REF_EQ", "LE", "GE", "BETWEEN" ], "documentation": " \n

\n The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n

\n

\n The comparison operators EQ and REF_EQ act on the following fields:\n

\n \n \n

\n The comparison operators GE, LE, and BETWEEN act on the following fields:\n

\n \n

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".

\n " }, "values": { "shape_name": "stringList", "type": "list", "members": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": null }, "documentation": " \n

The value that the actual field value will be compared with.

\n " } }, "documentation": " \n

Contains a logical operation for comparing the value of a field with a specified value.

\n " } }, "documentation": "\n

A comparision that is used to determine whether a query should return this object.

\n " }, "documentation": "\n

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

\n " } }, "documentation": "\n

\n Query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. \n The conditions in the query are limited to top-level String fields in the object. \n These filters can be applied to components, instances, and attempts. \n

\n " }, "sphere": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

\n Specifies whether the query applies to components or instances.\t\n Allowable values: COMPONENT, INSTANCE, ATTEMPT.\n

\n ", "required": true }, "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

\n The starting point for the results to be returned. The first time you call QueryObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.\n

\n " }, "limit": { "shape_name": "int", "type": "integer", "documentation": "\n

Specifies the maximum number of object names that QueryObjects will return in a single call. The default value is 100.

\n " } }, "documentation": "\n

The input for the QueryObjects action.

\n " }, "output": { "shape_name": "QueryObjectsOutput", "type": "structure", "members": { "ids": { "shape_name": "idList", "type": "list", "members": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": null }, "documentation": "\n

A list of identifiers that match the query selectors.

\n " }, "marker": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

\n The starting point for the results to be returned. As long as the action returns HasMoreResults as True, you can call QueryObjects again and pass the marker value from the response to retrieve the next set of results.\n

\n " }, "hasMoreResults": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, there are more results that can be obtained by a subsequent call to QueryObjects.

\n " } }, "documentation": "\n

Contains the output from the QueryObjects action.

\n " }, "errors": [ { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " }, { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

Queries a pipeline for the names of objects that match a specified set of conditions.

\n \n

The objects returned by QueryObjects are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If HasMoreResults is set to True, you should continue to call QueryObjects, passing in the returned value for marker, until HasMoreResults returns False.

\n\n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.QueryObjects\nContent-Length: 123\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"query\": \n {\"selectors\": \n [\n ]\n },\n \"sphere\": \"PO\",\n \"marker\": \"\",\n \"limit\": 10}\n\n \n \n \n \n\nx-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 72\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"ids\": \n [\"@SayHello_1_2012-09-25T17:00:00\"]\n}\n \n \n \n " }, "ReportTaskProgress": { "name": "ReportTaskProgress", "input": { "shape_name": "ReportTaskProgressInput", "type": "structure", "members": { "taskId": { "shape_name": "taskId", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 2048, "documentation": "\n

Identifier of the task assigned to the task runner. This value is provided in the TaskObject that the service returns with the response for the PollForTask action.

\n ", "required": true } }, "documentation": "\n

The input for the ReportTaskProgress action.

\n " }, "output": { "shape_name": "ReportTaskProgressOutput", "type": "structure", "members": { "canceled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

\n ", "required": true } }, "documentation": "\n

Contains the output from the ReportTaskProgress action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "TaskNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified task was not found.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

\n Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.\n \n \n \n If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to PollForTask. task runners should call ReportTaskProgress every 60 seconds.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskProgress\nContent-Length: 832\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"fields\": \n [\n {\"key\": \"percentComplete\",\n \"stringValue\": \"50\"}\n ]\n}\n\n \n \n \n\nx-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"canceled\": false}\n \n\n \n \n " }, "ReportTaskRunnerHeartbeat": { "name": "ReportTaskRunnerHeartbeat", "input": { "shape_name": "ReportTaskRunnerHeartbeatInput", "type": "structure", "members": { "taskrunnerId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

\n ", "required": true }, "workerGroup": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to ReportTaskRunnerHeartbeat. There are no wildcard values permitted in workerGroup, the string must be an exact, case-sensitive, match.

\n " }, "hostname": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The public DNS name of the calling task runner.

\n " } }, "documentation": "\n

The input for the ReportTaskRunnerHeartbeat action.

\n " }, "output": { "shape_name": "ReportTaskRunnerHeartbeatOutput", "type": "structure", "members": { "terminate": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

Indicates whether the calling task runner should terminate. If True, the task runner that called ReportTaskRunnerHeartbeat should terminate.

\n ", "required": true } }, "documentation": "\n

Contains the output from the ReportTaskRunnerHeartbeat action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat\nContent-Length: 84\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskrunnerId\": \"1234567890\",\n \"workerGroup\": \"wg-12345\",\n \"hostname\": \"example.com\"}\n\n \n \n \n\nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 20\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"terminate\": false}\n \n \n \n " }, "SetStatus": { "name": "SetStatus", "input": { "shape_name": "SetStatusInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifies the pipeline that contains the objects.

\n ", "required": true }, "objectIds": { "shape_name": "idList", "type": "list", "members": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": null }, "documentation": "\n

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

\n ", "required": true }, "status": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

\n ", "required": true } }, "documentation": "\n

The input to the SetStatus action.

\n " }, "output": null, "errors": [ { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " }, { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " } ], "documentation": "\n

Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetStatus\nContent-Length: 100\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0634701J7KEXAMPLE\", \n \"objectIds\": \n [\"o-08600941GHJWMBR9E2\"], \n \"status\": \"pause\"}\n\n \n \n \n\nx-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n \n \n \n " }, "SetTaskStatus": { "name": "SetTaskStatus", "input": { "shape_name": "SetTaskStatusInput", "type": "structure", "members": { "taskId": { "shape_name": "taskId", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 2048, "documentation": "\n

Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

\n ", "required": true }, "taskStatus": { "shape_name": "TaskStatus", "type": "string", "enum": [ "FINISHED", "FAILED", "FALSE" ], "documentation": "\n

If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.

\n ", "required": true }, "errorId": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

\n " }, "errorMessage": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

\n " }, "errorStackTrace": { "shape_name": "string", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 1024, "documentation": "\n

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

\n " } }, "documentation": "\n

The input of the SetTaskStatus action.

\n " }, "output": { "shape_name": "SetTaskStatusOutput", "type": "structure", "members": {}, "documentation": "\n

The output from the SetTaskStatus action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "TaskNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified task was not found.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

\n Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.\n

\n \n \n \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetTaskStatus\nContent-Length: 847\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"taskStatus\": \"FINISHED\"}\n \n \n \n \n\nx-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 \nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n \n \n \n " }, "ValidatePipelineDefinition": { "name": "ValidatePipelineDefinition", "input": { "shape_name": "ValidatePipelineDefinitionInput", "type": "structure", "members": { "pipelineId": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifies the pipeline whose definition is to be validated.

\n ", "required": true }, "pipelineObjects": { "shape_name": "PipelineObjectList", "type": "list", "members": { "shape_name": "PipelineObject", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Identifier of the object.

\n ", "required": true }, "name": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

Name of the object.

\n ", "required": true }, "fields": { "shape_name": "fieldList", "type": "list", "members": { "shape_name": "Field", "type": "structure", "members": { "key": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field identifier.

\n ", "required": true }, "stringValue": { "shape_name": "fieldStringValue", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10240, "documentation": "\n

The field value, expressed as a String.

\n " }, "refValue": { "shape_name": "fieldNameString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The field value, expressed as the identifier of another object.

\n " } }, "documentation": "\n

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

\n " }, "documentation": "\n

Key-value pairs that define the properties of the object.

\n ", "required": true } }, "documentation": "\n

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

\n " }, "documentation": "\n

A list of objects that define the pipeline changes to validate against the pipeline.

\n ", "required": true } }, "documentation": "\n

The input of the ValidatePipelineDefinition action.

\n " }, "output": { "shape_name": "ValidatePipelineDefinitionOutput", "type": "structure", "members": { "validationErrors": { "shape_name": "ValidationErrors", "type": "list", "members": { "shape_name": "ValidationError", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the object that contains the validation error.

\n " }, "errors": { "shape_name": "validationMessages", "type": "list", "members": { "shape_name": "validationMessage", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10000, "documentation": null }, "documentation": "\n

A description of the validation error.

\n " } }, "documentation": "\n

Defines a validation error returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

\n " }, "documentation": "\n

Lists the validation errors that were found by ValidatePipelineDefinition.

\n " }, "validationWarnings": { "shape_name": "ValidationWarnings", "type": "list", "members": { "shape_name": "ValidationWarning", "type": "structure", "members": { "id": { "shape_name": "id", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 1024, "documentation": "\n

The identifier of the object that contains the validation warning.

\n " }, "warnings": { "shape_name": "validationMessages", "type": "list", "members": { "shape_name": "validationMessage", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10000, "documentation": null }, "documentation": "\n

A description of the validation warning.

\n " } }, "documentation": "\n

Defines a validation warning returned by PutPipelineDefinition or ValidatePipelineDefinition. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

\n " }, "documentation": "\n

Lists the validation warnings that were found by ValidatePipelineDefinition.

\n " }, "errored": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

If True, there were validation errors.

\n ", "required": true } }, "documentation": "\n

Contains the output from the ValidatePipelineDefinition action.

\n " }, "errors": [ { "shape_name": "InternalServiceError", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

An internal service error occurred.

\n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

\n " }, { "shape_name": "PipelineNotFoundException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

\n " }, { "shape_name": "PipelineDeletedException", "type": "structure", "members": { "message": { "shape_name": "errorMessage", "type": "string", "documentation": "\n

Description of the error message.

\n " } }, "documentation": "\n

The specified pipeline has been deleted.

\n " } ], "documentation": "\n

Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.

\n\n \n \n Example 1\n \n This example sets an valid pipeline configuration and returns success.\n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 936\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nx-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n \n \n \n \n Example 2\n \n This example sets an invalid pipeline configuration and returns the associated set of validation errors.\n \n \n \n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"bad-time\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n \n \n \nx-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd\nContent-Type: application/x-amz-json-1.1\nContent-Length: 278\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": true, \n \"validationErrors\": \n [\n {\"errors\": \n [\"INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value.\"], \n \"id\": \"Schedule\"}\n ]\n}\n \n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/directconnect.json0000644000175000017500000044140712254746564021777 0ustar takakitakaki{ "api_version": "2012-10-25", "type": "json", "json_version": 1.1, "target_prefix": "OvertureService", "signature_version": "v4", "service_full_name": "AWS Direct Connect", "endpoint_prefix": "directconnect", "xmlnamespace": "http://directconnect.amazonaws.com/doc/2012-10-25/", "documentation": "\n

AWS Direct Connect makes it easy to establish a dedicated network connection from your premises to Amazon Web Services (AWS). Using AWS Direct Connect, you can establish private connectivity between AWS and your data center, office, or colocation environment, which in many cases can reduce your network costs, increase bandwidth throughput, and provide a more consistent network experience than Internet-based connections.

\n\n

The AWS Direct Connect API Reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Direct Connect. Use the following links to get started using the AWS Direct Connect API Reference:

\n \n ", "operations": { "AllocateConnectionOnInterconnect": { "name": "AllocateConnectionOnInterconnect", "input": { "shape_name": "AllocateConnectionOnInterconnectRequest", "type": "structure", "members": { "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n ", "required": true }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

Name of the provisioned connection.

\n

Example: \"500M Connection to AWS\"

\n

Default: None

\n ", "required": true }, "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": "\n

Numeric account Id of the customer for whom the connection will be provisioned.

\n

Example: 123443215678

\n

Default: None

\n ", "required": true }, "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

ID of the interconnect on which the connection will be provisioned.

\n

Example: dxcon-456abc78

\n

Default: None

\n ", "required": true }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The dedicated VLAN provisioned to the connection.

\n

Example: 101

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the AllocateConnectionOnInterconnect operation.

\n " }, "output": { "shape_name": "Connection", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n " }, "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "partnerName": { "shape_name": "PartnerName", "type": "string", "documentation": null } }, "documentation": "\n

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Creates a hosted connection on an interconnect.

\n

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

\n " }, "AllocatePrivateVirtualInterface": { "name": "AllocatePrivateVirtualInterface", "input": { "shape_name": "AllocatePrivateVirtualInterfaceRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

The connection ID on which the private virtual interface is provisioned.

\n

Default: None

\n ", "required": true }, "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": "\n

The AWS account that will own the new private virtual interface.

\n

Default: None

\n ", "required": true }, "newPrivateVirtualInterfaceAllocation": { "shape_name": "NewPrivateVirtualInterfaceAllocation", "type": "structure", "members": { "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n ", "required": true }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n ", "required": true }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n ", "required": true }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " } }, "documentation": "\n

Detailed information for the private virtual interface to be provisioned.

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the AllocatePrivateVirtualInterface operation.

\n " }, "output": { "shape_name": "VirtualInterface", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceType": { "shape_name": "VirtualInterfaceType", "type": "string", "documentation": "\n

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

\n " }, "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n " }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " }, "customerRouterConfig": { "shape_name": "RouterConfig", "type": "string", "documentation": "\n

Information for generating the customer router configuration.

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n " } }, "documentation": "\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Provisions a private virtual interface to be owned by a different customer.

\n

The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.

\n

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

\n " }, "AllocatePublicVirtualInterface": { "name": "AllocatePublicVirtualInterface", "input": { "shape_name": "AllocatePublicVirtualInterfaceRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

The connection ID on which the public virtual interface is provisioned.

\n

Default: None

\n ", "required": true }, "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": "\n

The AWS account that will own the new public virtual interface.

\n

Default: None

\n ", "required": true }, "newPublicVirtualInterfaceAllocation": { "shape_name": "NewPublicVirtualInterfaceAllocation", "type": "structure", "members": { "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n ", "required": true }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n ", "required": true }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n ", "required": true }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n ", "required": true }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n ", "required": true }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n ", "required": true } }, "documentation": "\n

Detailed information for the public virtual interface to be provisioned.

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the AllocatePublicVirtualInterface operation.

\n " }, "output": { "shape_name": "VirtualInterface", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceType": { "shape_name": "VirtualInterfaceType", "type": "string", "documentation": "\n

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

\n " }, "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n " }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " }, "customerRouterConfig": { "shape_name": "RouterConfig", "type": "string", "documentation": "\n

Information for generating the customer router configuration.

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n " } }, "documentation": "\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Provisions a public virtual interface to be owned by a different customer.

\n

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

\n

Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.

\n " }, "ConfirmConnection": { "name": "ConfirmConnection", "input": { "shape_name": "ConfirmConnectionRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the ConfirmConnection operation.

\n " }, "output": { "shape_name": "ConfirmConnectionResponse", "type": "structure", "members": { "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " } }, "documentation": "\n

The response received when ConfirmConnection is called.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Confirm the creation of a hosted connection on an interconnect.

\n

Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.

\n " }, "ConfirmPrivateVirtualInterface": { "name": "ConfirmPrivateVirtualInterface", "input": { "shape_name": "ConfirmPrivateVirtualInterfaceRequest", "type": "structure", "members": { "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n ", "required": true }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

ID of the virtual private gateway that will be attached to the virtual interface.

\n

A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the ConfirmPrivateVirtualInterface operation.

\n " }, "output": { "shape_name": "ConfirmPrivateVirtualInterfaceResponse", "type": "structure", "members": { "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " } }, "documentation": "\n

The response received when ConfirmPrivateVirtualInterface is called.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Accept ownership of a private virtual interface created by another customer.

\n

After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.

\n " }, "ConfirmPublicVirtualInterface": { "name": "ConfirmPublicVirtualInterface", "input": { "shape_name": "ConfirmPublicVirtualInterfaceRequest", "type": "structure", "members": { "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the ConfirmPublicVirtualInterface operation.

\n " }, "output": { "shape_name": "ConfirmPublicVirtualInterfaceResponse", "type": "structure", "members": { "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " } }, "documentation": "\n

The response received when ConfirmPublicVirtualInterface is called.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Accept ownership of a public virtual interface created by another customer.

\n

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

\n " }, "CreateConnection": { "name": "CreateConnection", "input": { "shape_name": "CreateConnectionRequest", "type": "structure", "members": { "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n ", "required": true }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n ", "required": true }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the CreateConnection operation.

\n " }, "output": { "shape_name": "Connection", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n " }, "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "partnerName": { "shape_name": "PartnerName", "type": "string", "documentation": null } }, "documentation": "\n

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Creates a new connection between the customer network and a specific AWS Direct Connect location.

\n\n

A connection links your internal network to an AWS Direct Connect location over a standard 1\n gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your\n router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.

\n " }, "CreateInterconnect": { "name": "CreateInterconnect", "input": { "shape_name": "CreateInterconnectRequest", "type": "structure", "members": { "interconnectName": { "shape_name": "InterconnectName", "type": "string", "documentation": "\n

The name of the interconnect.

\n

Example: \"1G Interconnect to AWS\"

\n

Default: None

\n ", "required": true }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

The port bandwidth

\n

Example: 1Gbps

\n

Default: None

\n

Available values: 1Gbps,10Gbps

\n ", "required": true }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the interconnect is located

\n

Example: EqSV5

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the CreateInterconnect operation.

\n " }, "output": { "shape_name": "Interconnect", "type": "structure", "members": { "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

The ID of the interconnect.

\n

Example: dxcon-abc123

\n " }, "interconnectName": { "shape_name": "InterconnectName", "type": "string", "documentation": "\n

The name of the interconnect.

\n

Example: \"1G Interconnect to AWS\"

\n " }, "interconnectState": { "shape_name": "InterconnectState", "type": "string", "enum": [ "requested", "pending", "available", "down", "deleting", "deleted" ], "documentation": "\n State of the interconnect.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " } }, "documentation": "\n

An interconnect is a connection that can host other connections.

\n

Like a standard AWS Direct Connect connection, an interconnect represents the physical\n connection between an AWS Direct Connect partner's network and a specific Direct Connect\n location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

\n

The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

\n

An interconnect is a connection which is capable of hosting other connections. The AWS\n Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service\n to tier 2 customers who do not have their own connections. Like a standard connection, an\n interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

\n

For each end customer, the AWS Direct Connect partner provisions a connection on their\n interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect\n to AWS resources by creating a virtual interface on their connection, using the VLAN assigned\n to them by the AWS Direct Connect partner.

\n " }, "CreatePrivateVirtualInterface": { "name": "CreatePrivateVirtualInterface", "input": { "shape_name": "CreatePrivateVirtualInterfaceRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n ", "required": true }, "newPrivateVirtualInterface": { "shape_name": "NewPrivateVirtualInterface", "type": "structure", "members": { "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n ", "required": true }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n ", "required": true }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n ", "required": true }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n ", "required": true } }, "documentation": "\n

Detailed information for the private virtual interface to be created.

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the CreatePrivateVirtualInterface operation.

\n " }, "output": { "shape_name": "VirtualInterface", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceType": { "shape_name": "VirtualInterfaceType", "type": "string", "documentation": "\n

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

\n " }, "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n " }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " }, "customerRouterConfig": { "shape_name": "RouterConfig", "type": "string", "documentation": "\n

Information for generating the customer router configuration.

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n " } }, "documentation": "\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS\n Direct Connect traffic. A private virtual interface supports sending traffic to a single\n virtual private cloud (VPC).

\n " }, "CreatePublicVirtualInterface": { "name": "CreatePublicVirtualInterface", "input": { "shape_name": "CreatePublicVirtualInterfaceRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n ", "required": true }, "newPublicVirtualInterface": { "shape_name": "NewPublicVirtualInterface", "type": "structure", "members": { "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n ", "required": true }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n ", "required": true }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n ", "required": true }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n ", "required": true }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n ", "required": true }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n ", "required": true } }, "documentation": "\n

Detailed information for the public virtual interface to be created.

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the CreatePublicVirtualInterface operation.

\n " }, "output": { "shape_name": "VirtualInterface", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceType": { "shape_name": "VirtualInterfaceType", "type": "string", "documentation": "\n

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

\n " }, "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n " }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " }, "customerRouterConfig": { "shape_name": "RouterConfig", "type": "string", "documentation": "\n

Information for generating the customer router configuration.

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n " } }, "documentation": "\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).

\n " }, "DeleteConnection": { "name": "DeleteConnection", "input": { "shape_name": "DeleteConnectionRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the DeleteConnection operation.

\n " }, "output": { "shape_name": "Connection", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n " }, "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "partnerName": { "shape_name": "PartnerName", "type": "string", "documentation": null } }, "documentation": "\n

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Deletes the connection.

\n

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges.\n You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.

\n " }, "DeleteInterconnect": { "name": "DeleteInterconnect", "input": { "shape_name": "DeleteInterconnectRequest", "type": "structure", "members": { "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

The ID of the interconnect.

\n

Example: dxcon-abc123

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the DeleteInterconnect operation.

\n " }, "output": { "shape_name": "DeleteInterconnectResponse", "type": "structure", "members": { "interconnectState": { "shape_name": "InterconnectState", "type": "string", "enum": [ "requested", "pending", "available", "down", "deleting", "deleted" ], "documentation": "\n State of the interconnect.\n \n " } }, "documentation": "\n

The response received when DeleteInterconnect is called.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Deletes the specified interconnect.

\n " }, "DeleteVirtualInterface": { "name": "DeleteVirtualInterface", "input": { "shape_name": "DeleteVirtualInterfaceRequest", "type": "structure", "members": { "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the DeleteVirtualInterface operation.

\n " }, "output": { "shape_name": "DeleteVirtualInterfaceResponse", "type": "structure", "members": { "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " } }, "documentation": "\n

The response received when DeleteVirtualInterface is called.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Deletes a virtual interface.

\n " }, "DescribeConnections": { "name": "DescribeConnections", "input": { "shape_name": "DescribeConnectionsRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " } }, "documentation": "\n

Container for the parameters to the DescribeConnections operation.

\n " }, "output": { "shape_name": "Connections", "type": "structure", "members": { "connections": { "shape_name": "ConnectionList", "type": "list", "members": { "shape_name": "Connection", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n " }, "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "partnerName": { "shape_name": "PartnerName", "type": "string", "documentation": null } }, "documentation": "\n

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

\n " }, "documentation": "\n

A list of connections.

\n " } }, "documentation": "\n

A structure containing a list of connections.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Displays all connections in this region.

\n

If a connection ID is provided, the call returns only that particular connection.

\n " }, "DescribeConnectionsOnInterconnect": { "name": "DescribeConnectionsOnInterconnect", "input": { "shape_name": "DescribeConnectionsOnInterconnectRequest", "type": "structure", "members": { "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

ID of the interconnect on which a list of connection is provisioned.

\n

Example: dxcon-abc123

\n

Default: None

\n ", "required": true } }, "documentation": "\n

Container for the parameters to the DescribeConnectionsOnInterconnect operation.

\n " }, "output": { "shape_name": "Connections", "type": "structure", "members": { "connections": { "shape_name": "ConnectionList", "type": "list", "members": { "shape_name": "Connection", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "connectionName": { "shape_name": "ConnectionName", "type": "string", "documentation": "\n

The name of the connection.

\n

Example: \"1G Connection to AWS\"

\n

Default: None

\n " }, "connectionState": { "shape_name": "ConnectionState", "type": "string", "enum": [ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ], "documentation": "\n State of the connection.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "partnerName": { "shape_name": "PartnerName", "type": "string", "documentation": null } }, "documentation": "\n

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

\n " }, "documentation": "\n

A list of connections.

\n " } }, "documentation": "\n

A structure containing a list of connections.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Return a list of connections that have been provisioned on the given interconnect.

\n " }, "DescribeInterconnects": { "name": "DescribeInterconnects", "input": { "shape_name": "DescribeInterconnectsRequest", "type": "structure", "members": { "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

The ID of the interconnect.

\n

Example: dxcon-abc123

\n " } }, "documentation": "\n

Container for the parameters to the DescribeInterconnects operation.

\n " }, "output": { "shape_name": "Interconnects", "type": "structure", "members": { "interconnects": { "shape_name": "InterconnectList", "type": "list", "members": { "shape_name": "Interconnect", "type": "structure", "members": { "interconnectId": { "shape_name": "InterconnectId", "type": "string", "documentation": "\n

The ID of the interconnect.

\n

Example: dxcon-abc123

\n " }, "interconnectName": { "shape_name": "InterconnectName", "type": "string", "documentation": "\n

The name of the interconnect.

\n

Example: \"1G Interconnect to AWS\"

\n " }, "interconnectState": { "shape_name": "InterconnectState", "type": "string", "enum": [ "requested", "pending", "available", "down", "deleting", "deleted" ], "documentation": "\n State of the interconnect.\n \n " }, "region": { "shape_name": "Region", "type": "string", "documentation": "\n

The AWS region where the connection is located.

\n

Example: us-east-1

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "bandwidth": { "shape_name": "Bandwidth", "type": "string", "documentation": "\n

Bandwidth of the connection.

\n

Example: 1Gbps

\n

Default: None

\n " } }, "documentation": "\n

An interconnect is a connection that can host other connections.

\n

Like a standard AWS Direct Connect connection, an interconnect represents the physical\n connection between an AWS Direct Connect partner's network and a specific Direct Connect\n location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.

\n

The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.

\n " }, "documentation": "\n

A list of interconnects.

\n " } }, "documentation": "\n

A structure containing a list of interconnects.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Returns a list of interconnects owned by the AWS account.

\n

If an interconnect ID is provided, it will only return this particular interconnect.

\n " }, "DescribeLocations": { "name": "DescribeLocations", "input": null, "output": { "shape_name": "Locations", "type": "structure", "members": { "locations": { "shape_name": "LocationList", "type": "list", "members": { "shape_name": "Location", "type": "structure", "members": { "locationCode": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

The code used to indicate the AWS Direct Connect location.

\n " }, "locationName": { "shape_name": "LocationName", "type": "string", "documentation": "\n

The name of the AWS Direct Connect location. The name includes the colocation partner name\n and the physical site of the lit building.

\n " } }, "documentation": "\n

An AWS Direct Connect location where connections and interconnects can be requested.

\n " }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.

\n " }, "DescribeVirtualGateways": { "name": "DescribeVirtualGateways", "input": null, "output": { "shape_name": "VirtualGateways", "type": "structure", "members": { "virtualGateways": { "shape_name": "VirtualGatewayList", "type": "list", "members": { "shape_name": "VirtualGateway", "type": "structure", "members": { "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "virtualGatewayState": { "shape_name": "VirtualGatewayState", "type": "string", "documentation": "\n State of the virtual private gateway.\n \n " } }, "documentation": "\n

You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.

\n

Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC)\n console or the Amazon\n EC2 CreateVpnGateway action.

\n " }, "documentation": "\n

A list of virtual private gateways.

\n " } }, "documentation": "\n

A structure containing a list of virtual private gateways.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Returns a list of virtual private gateways owned by the AWS account.

\n

You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

\n " }, "DescribeVirtualInterfaces": { "name": "DescribeVirtualInterfaces", "input": { "shape_name": "DescribeVirtualInterfacesRequest", "type": "structure", "members": { "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " } }, "documentation": "\n

Container for the parameters to the DescribeVirtualInterfaces operation.

\n " }, "output": { "shape_name": "VirtualInterfaces", "type": "structure", "members": { "virtualInterfaces": { "shape_name": "VirtualInterfaceList", "type": "list", "members": { "shape_name": "VirtualInterface", "type": "structure", "members": { "ownerAccount": { "shape_name": "OwnerAccount", "type": "string", "documentation": null }, "virtualInterfaceId": { "shape_name": "VirtualInterfaceId", "type": "string", "documentation": "\n

ID of the virtual interface.

\n

Example: dxvif-123dfg56

\n

Default: None

\n " }, "location": { "shape_name": "LocationCode", "type": "string", "documentation": "\n

Where the connection is located.

\n

Example: EqSV5

\n

Default: None

\n " }, "connectionId": { "shape_name": "ConnectionId", "type": "string", "documentation": "\n

ID of the connection.

\n

Example: dxcon-fg5678gh

\n

Default: None

\n " }, "virtualInterfaceType": { "shape_name": "VirtualInterfaceType", "type": "string", "documentation": "\n

The type of virtual interface.

\n

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

\n " }, "virtualInterfaceName": { "shape_name": "VirtualInterfaceName", "type": "string", "documentation": "\n

The name of the virtual interface assigned by the customer.

\n

Example: \"My VPC\"

\n " }, "vlan": { "shape_name": "VLAN", "type": "integer", "documentation": "\n

The VLAN ID.

\n

Example: 101

\n " }, "asn": { "shape_name": "ASN", "type": "integer", "documentation": "\n

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

\n

Example: 65000

\n " }, "authKey": { "shape_name": "BGPAuthKey", "type": "string", "documentation": "\n

Authentication key for BGP configuration.

\n

Example: asdf34example

\n " }, "amazonAddress": { "shape_name": "AmazonAddress", "type": "string", "documentation": "\n

IP address assigned to the Amazon interface.

\n

Example: 192.168.1.1/30

\n " }, "customerAddress": { "shape_name": "CustomerAddress", "type": "string", "documentation": "\n

IP address assigned to the customer interface.

\n

Example: 192.168.1.2/30

\n " }, "virtualInterfaceState": { "shape_name": "VirtualInterfaceState", "type": "string", "enum": [ "confirming", "verifying", "pending", "available", "deleting", "deleted", "rejected" ], "documentation": "\n State of the virtual interface.\n \n " }, "customerRouterConfig": { "shape_name": "RouterConfig", "type": "string", "documentation": "\n

Information for generating the customer router configuration.

\n " }, "virtualGatewayId": { "shape_name": "VirtualGatewayId", "type": "string", "documentation": "\n

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

\n

Example: vgw-123er56

\n " }, "routeFilterPrefixes": { "shape_name": "RouteFilterPrefixList", "type": "list", "members": { "shape_name": "RouteFilterPrefix", "type": "structure", "members": { "cidr": { "shape_name": "CIDR", "type": "string", "documentation": "\n

CIDR notation for the advertised route. Multiple routes are separated by commas.

\n

Example: 10.10.10.0/24,10.10.11.0/24

\n " } }, "documentation": "\n

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

\n " }, "documentation": "\n

A list of routes to be advertised to the AWS network in this region (public virtual interface) or your VPC (private virtual interface).

\n " } }, "documentation": "\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n " }, "documentation": "\n

A list of virtual interfaces.

\n " } }, "documentation": "\n

A structure containing a list of virtual interfaces.

\n " }, "errors": [ { "shape_name": "DirectConnectServerException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

A server-side error occurred during the API call. The error message will contain additional details about the cause.

\n " }, { "shape_name": "DirectConnectClientException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The API was called with invalid parameters. The error message will contain additional details about the cause.

\n " } ], "documentation": "\n

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.

\n

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

\n

If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.

\n " } }, "metadata": { "regions": { "us-east-1": null, "eu-west-1": null, "us-west-1": null, "sa-east-1": null, "ap-northeast-1": null, "ap-southeast-1": null, "ap-southeast-2": null }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/dynamodb.json0000644000175000017500000212517012254746566020750 0ustar takakitakaki{ "api_version": "2012-08-10", "type": "json", "json_version": 1.0, "target_prefix": "DynamoDB_20120810", "signature_version": "v4", "service_full_name": "Amazon DynamoDB", "service_abbreviation": "DynamoDB", "endpoint_prefix": "dynamodb", "xmlnamespace": "http://dynamodb.amazonaws.com/doc/2012-08-10/", "documentation": "\n Amazon DynamoDB\n Overview\n

This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the Amazon DynamoDB\n API.

\n ", "operations": { "BatchGetItem": { "name": "BatchGetItem", "input": { "shape_name": "BatchGetItemInput", "type": "structure", "members": { "RequestItems": { "shape_name": "BatchGetRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "KeysAndAttributes", "type": "structure", "members": { "Keys": { "shape_name": "KeyList", "type": "list", "members": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": null }, "min_length": 1, "max_length": 100, "documentation": "\n

The primary key attribute values that define the items and the attributes\n associated with the items.

\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "\n

One or more attributes to retrieve from the table or index. If no attribute names are \n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.

\n

If you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.

\n\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "\n

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

\n " } }, "documentation": "\n

Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.

\n " }, "min_length": 1, "max_length": 100, "documentation": "\n

A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve.\n Each table name can be invoked only once.

\n

Each element in the map consists of the following:

\n \n ", "required": true }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " } }, "documentation": "\n

Represents the input of a BatchGetItem operation.

\n " }, "output": { "shape_name": "BatchGetItemOutput", "type": "structure", "members": { "Responses": { "shape_name": "BatchGetResponseMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": null }, "documentation": null }, "documentation": "\n

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

\n " }, "UnprocessedKeys": { "shape_name": "BatchGetRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "KeysAndAttributes", "type": "structure", "members": { "Keys": { "shape_name": "KeyList", "type": "list", "members": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": null }, "min_length": 1, "max_length": 100, "documentation": "\n

The primary key attribute values that define the items and the attributes\n associated with the items.

\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "\n

One or more attributes to retrieve from the table or index. If no attribute names are \n specified then all attributes will be returned. If any of the specified attributes are not\n found, they will not appear in the result.

\n

If you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.

\n\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "\n

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

\n " } }, "documentation": "\n

Represents a set of primary keys and, for each key, the attributes to retrieve from the\n table.

\n " }, "min_length": 1, "max_length": 100, "documentation": "\n

A map of tables and their respective keys that were not processed with the current response.\n The UnprocessedKeys value is in the same form as RequestItems, so the value can\n be provided directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each element consists of:

\n \n\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacityMultiple", "type": "list", "members": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " }, "documentation": "\n

The write capacity units consumed by the operation.

\n

Each element consists of:

\n \n " } }, "documentation": "\n

Represents the output of a BatchGetItem operation.

\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The \n BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 1 MB of data, which can comprise as many as 100 items.\n BatchGetItem will return a partial result if the response size limit is exceeded, the\n table's provisioned throughput is exceeded, or an internal processing failure occurs. If a\n partial result is returned, the operation returns a value for UnprocessedKeys. You can\n use this value to retry the operation starting with the next item to get.

\n

For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the\n system returns 20 items (1 MB) and an appropriate UnprocessedKeys value so you can get the\n next page of results. If desired, your application can include its own logic to assemble the\n pages of results into one dataset.

\n

If no items can be processed because of insufficient provisioned throughput on each of the\n tables involved in the request, BatchGetItem throws ProvisionedThroughputExceededException.

\n

By default, BatchGetItem performs eventually consistent reads on every table in the\n request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem fetches items in parallel.

\n

When designing your application, keep in mind that Amazon DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the\n AttributesToGet parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the\n type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

\n\n \n \n Retrieve Items From Multiple Tables\n The following sample requests attributes from two different\n tables.\n \n{\n \"Responses\": {\n \"Forum\": [\n {\n \"Name\":{\n \"S\":\"Amazon DynamoDB\"\n },\n \"Threads\":{\n \"N\":\"5\"\n },\n \"Messages\":{\n \"N\":\"19\"\n },\n \"Views\":{\n \"N\":\"35\"\n }\n },\n {\n \"Name\":{\n \"S\":\"Amazon RDS\"\n },\n \"Threads\":{\n \"N\":\"8\"\n },\n \"Messages\":{\n \"N\":\"32\"\n },\n \"Views\":{\n \"N\":\"38\"\n }\n },\n {\n \"Name\":{\n \"S\":\"Amazon Redshift\"\n },\n \"Threads\":{\n \"N\":\"12\"\n },\n \"Messages\":{\n \"N\":\"55\"\n },\n \"Views\":{\n \"N\":\"47\"\n }\n }\n ]\n \"Thread\": [\n {\n \"Tags\":{\n \"SS\":[\"Reads\",\"MultipleUsers\"]\n },\n \"Message\":{\n \"S\":\"How many users can read a single data item at a time? Are there any limits?\"\n }\n }\n ]\n },\n \"UnprocessedKeys\": {\n },\n \"ConsumedCapacity\": [\n {\n \"TableName\": \"Forum\",\n \"CapacityUnits\": 3\n },\n {\n \"TableName\": \"Thread\",\n \"CapacityUnits\": 1\n }\n ]\n}\n \n \n \n " }, "BatchWriteItem": { "name": "BatchWriteItem", "input": { "shape_name": "BatchWriteItemInput", "type": "structure", "members": { "RequestItems": { "shape_name": "BatchWriteItemRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "WriteRequests", "type": "list", "members": { "shape_name": "WriteRequest", "type": "structure", "members": { "PutRequest": { "shape_name": "PutRequest", "type": "structure", "members": { "Item": { "shape_name": "PutItemInputAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute name to attribute values, representing the primary key of an item to be\n processed by PutItem. All of the table's primary key attributes must be specified, and\n their data types must match those of the table's key schema. If any attributes are present in\n the item which are part of an index key schema for the table, their types must match the index\n key schema.

\n ", "required": true } }, "documentation": "\n

A request to perform a PutItem operation.

\n " }, "DeleteRequest": { "shape_name": "DeleteRequest", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

\n ", "required": true } }, "documentation": "\n

A request to perform a DeleteItem operation.

\n " } }, "documentation": "\n

Represents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.

\n " }, "min_length": 1, "max_length": 25, "documentation": null }, "min_length": 1, "max_length": 25, "documentation": "\n

A map of one or more table names and, for each table, a list of operations to be performed\n (DeleteRequest or PutRequest). Each element in the map consists of the following:

\n \n ", "required": true }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " }, "ReturnItemCollectionMetrics": { "shape_name": "ReturnItemCollectionMetrics", "type": "string", "enum": [ "SIZE", "NONE" ], "documentation": "\n

If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

\n " } }, "documentation": "\n

Represents the input of a BatchWriteItem operation.

\n " }, "output": { "shape_name": "BatchWriteItemOutput", "type": "structure", "members": { "UnprocessedItems": { "shape_name": "BatchWriteItemRequestMap", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "WriteRequests", "type": "list", "members": { "shape_name": "WriteRequest", "type": "structure", "members": { "PutRequest": { "shape_name": "PutRequest", "type": "structure", "members": { "Item": { "shape_name": "PutItemInputAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute name to attribute values, representing the primary key of an item to be\n processed by PutItem. All of the table's primary key attributes must be specified, and\n their data types must match those of the table's key schema. If any attributes are present in\n the item which are part of an index key schema for the table, their types must match the index\n key schema.

\n ", "required": true } }, "documentation": "\n

A request to perform a PutItem operation.

\n " }, "DeleteRequest": { "shape_name": "DeleteRequest", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

\n ", "required": true } }, "documentation": "\n

A request to perform a DeleteItem operation.

\n " } }, "documentation": "\n

Represents an operation to perform - either DeleteItem or PutItem. You can only specify one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to specify two separate WriteRequest objects.

\n " }, "min_length": 1, "max_length": 25, "documentation": null }, "min_length": 1, "max_length": 25, "documentation": "\n

A map of tables and requests against those tables that were not processed. The\n UnprocessedKeys value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name and, for that table, a list of\n operations to perform (DeleteRequest or PutRequest).

\n \n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetricsPerTable", "type": "map", "keys": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "ItemCollectionMetricsMultiple", "type": "list", "members": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The hash key value of the item collection. This is the same as the hash key of the item.

\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\n

An estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

\n " } }, "documentation": "\n

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n " }, "documentation": null }, "documentation": "\n

A list of tables that were processed by BatchWriteItem and, for each table,\n information about any item collections that were affected by individual DeleteItem or\n PutItem operations.

\n

Each entry consists of the following subelements:

\n \n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacityMultiple", "type": "list", "members": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " }, "documentation": "\n

The capacity units consumed by the operation.

\n

Each element consists of:

\n \n " } }, "documentation": "\n

Represents the output of a BatchWriteItem operation.

\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "ItemCollectionSizeLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

\n " } }, "documentation": "\n

An item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A\n single call to BatchWriteItem can write up to 1 MB of data, which can comprise as many\n as 25 put or delete requests. Individual items to be written can be as large as 64 KB.

\n \n

BatchWriteItem cannot update items. To update items, use the UpdateItem\n API.

\n \n

The individual PutItem and DeleteItem operations specified in\n BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any\n requested operations fail because the table's provisioned throughput is exceeded or an\n internal processing failure occurs, the failed operations are returned in the\n UnprocessedItems response parameter. You can investigate and optionally resend the\n requests. Typically, you would call BatchWriteItem in a loop. Each iteration would\n check for unprocessed items and submit a new BatchWriteItem request with those\n unprocessed items until all items have been processed.

\n

To write one item, you can use the PutItem operation; to delete one item, you can use the DeleteItem operation.

\n

With BatchWriteItem, you can efficiently write or delete large amounts of data, such\n as from Amazon Elastic MapReduce (EMR), or copy data from another database into Amazon DynamoDB. In\n order to improve performance with these large-scale operations, BatchWriteItem does not\n behave in the same way as individual PutItem and DeleteItem calls would For\n example, you cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, such as Java, you can use\n threads to write items in parallel. Your application must include the necessary logic to manage the threads.

\n

With languages that don't support threading, such as PHP, BatchWriteItem will write or\n delete the specified items one at a time. In both situations, BatchWriteItem provides\n an alternative where the API performs the specified put and delete operations in parallel,\n giving you the power of the thread pool approach without having to introduce complexity into\n your application.

\n

Parallel processing reduces latency, but each specified put and delete request consumes the\n same number of write capacity units whether it is processed in parallel or not. Delete\n operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, Amazon DynamoDB rejects the entire batch write operation:

\n \n\n \n \n Multiple Operations on One Table\n This example writes several items to the Forum table. The response shows that\n the final put operation failed, possibly because the application exceeded the provisioned\n throughput on the table. The UnprocessedItems object shows the unsuccessful put request.\n The application can call BatchWriteItem again to address such unprocessed\n requests.\n {\n \"UnprocessedItems\": {\n \"Forum\": [\n {\n \"PutRequest\": {\n \"Item\": {\n \"Name\": {\n \"S\": \"Amazon ElastiCache\"\n },\n \"Category\": {\n \"S\": \"Amazon Web Services\"\n }\n }\n }\n }\n ]\n },\n \"ConsumedCapacity\": [\n {\n \"TableName\": \"Forum\",\n \"CapacityUnits\": 3\n }\n ]\n}\n \n \n \n " }, "CreateTable": { "name": "CreateTable", "input": { "shape_name": "CreateTableInput", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

A name for the attribute.

\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\n

The data type for the attribute.

\n ", "required": true } }, "documentation": "\n

Represents an attribute for describing the key schema for the table and indexes.

\n " }, "documentation": "\n

An array of attributes that describe the key schema for the table and indexes.

\n ", "required": true }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table to create.

\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

Specifies the attributes that make up the primary key for a table or an index. The attributes in\n KeySchema must also be defined in the AttributeDefinitions array. For more\n information, see Data\n Model in the Amazon DynamoDB Developer Guide.

\n

Each KeySchemaElement in the array is composed of:

\n \n

For a primary key that consists of a hash attribute, you must specify exactly one element with a KeyType of HASH.

\n

For a primary key that consists of hash and range attributes, you must specify exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

\n

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

\n ", "required": true }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexList", "type": "list", "members": { "shape_name": "LocalSecondaryIndex", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the local secondary index. The name must be unique among all other indexes\n on this table.

\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).

", "required": true }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n ", "required": true } }, "documentation": "\n

Represents a local secondary index.

\n " }, "documentation": "\n

One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given\n hash key value. There is a 10 gigabyte size limit per hash key; otherwise, the size of a local secondary index is unconstrained.

\n

Each local secondary index in the array includes the following:

\n \n " }, "GlobalSecondaryIndexes": { "shape_name": "GlobalSecondaryIndexList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndex", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index. The name must be unique among all other indexes on this table.

\n ", "required": true }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for a global secondary index, which consists of one or more pairs of attribute\n names and key types (HASH or RANGE).

\n ", "required": true }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents a global secondary index.

\n " }, "documentation": "\n

One or more global secondary indexes (the maximum is five) to be created on the table. Each global secondary index in the array includes the following:

\n \n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateTable operation.

\n " }, "output": { "shape_name": "CreateTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

A name for the attribute.

\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\n

The data type for the attribute.

\n ", "required": true } }, "documentation": "\n

Represents an attribute for describing the key schema for the table and indexes.

\n " }, "documentation": "\n

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n \n " }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the table:

\n \n " }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the table was created, in UNIX epoch time format.

\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

Represents the name of the local secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a local secondary index.

\n " }, "documentation": "\n

Represents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "GlobalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).

\n " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the global secondary index:

\n \n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

Represents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a global secondary index.

\n " }, "documentation": "\n

The global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " } }, "documentation": "\n

Represents the properties of a table.

\n " } }, "documentation": "\n

Represents the output of a CreateTable operation.

\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being attempted to be changed is in use.

\n " } }, "documentation": "\n

The operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Too many operations for a given subscriber.

\n " } }, "documentation": "\n

The number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.

\n

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

\n

The total limit of tables in the ACTIVE state is 250.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The CreateTable operation adds a new table to your account. In an AWS account, table\n names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.

\n

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, Amazon DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, Amazon DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

\n

If you want to create multiple tables with secondary indexes on them, you must create them sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

\n

You can use the DescribeTable API to check the table status.

\n \n \n Create a Table\n This example creates a table named Thread. The table primary key\n consists of ForumName (hash) and Subject (range). A local secondary index is also created; its key consists of ForumName (hash) and LastPostDateTime (range).\n \n{\n \"TableDescription\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.36372808007E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"CREATING\"\n }\n}\n \n \n \n " }, "DeleteItem": { "name": "DeleteItem", "input": { "shape_name": "DeleteItemInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table from which to delete the item.

\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

\n ", "required": true }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

\n \n

The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.

\n

Amazon DynamoDB returns a ValidationException if:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n " } }, "documentation": "\n

Represents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.

\n " }, "documentation": "\n

A map of attribute/condition pairs. This is the conditional block for the DeleteItemoperation. All the conditions must be met for the operation to succeed.

Expected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.

\n

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n\n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\n

Use ReturnValues if you want to get the item attributes as they appeared before they were\n deleted. For DeleteItem, the valid values are:

\n \n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " }, "ReturnItemCollectionMetrics": { "shape_name": "ReturnItemCollectionMetrics", "type": "string", "enum": [ "SIZE", "NONE" ], "documentation": "

If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

\n " } }, "documentation": "\n

Represents the input of a DeleteItem operation.

\n " }, "output": { "shape_name": "DeleteItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute names to AttributeValue objects, representing the item as it appeared\n before the DeleteItem operation. This map appears in the response only\n if ReturnValues was specified as ALL_OLD in the request.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The hash key value of the item collection. This is the same as the hash key of the item.

\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\n

An estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

\n " } }, "documentation": "

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.

\n

Each ItemCollectionMetrics\n element consists of:

\n \n " } }, "documentation": "\n

Represents the output of a DeleteItem operation.

\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The conditional request failed.

\n " } }, "documentation": "\n

A condition specified in the operation could not be evaluated.

\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "ItemCollectionSizeLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

\n " } }, "documentation": "\n

An item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute value.

\n

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

\n

Unless you specify conditions, the DeleteItem is an idempotent operation; running it\n multiple times on the same item or attribute does not result in an error\n response.

\n

Conditional deletes are useful for only deleting items if specific conditions are met. If those\n conditions are met, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.

\n \n \n Delete an Item\n This example deletes an item from the Thread table, but only if that item does\n not have an attribute named Replies. Because ReturnValues is set to ALL_OLD, the response\n contains the item as it appeared before the delete.\n \n{\n \"Attributes\": {\n \"LastPostedBy\": {\n \"S\": \"fred@example.com\"\n },\n \"ForumName\": {\n \"S\": \"Amazon DynamoDB\"\n },\n \"LastPostDateTime\": {\n \"S\": \"201303201023\"\n },\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"Subject\": {\n \"S\": \"How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"I want to update multiple items in a single API call. What's the best way to do that?\"\n }\n }\n}\n \n \n \n " }, "DeleteTable": { "name": "DeleteTable", "input": { "shape_name": "DeleteTableInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table to delete.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteTable operation.

\n " }, "output": { "shape_name": "DeleteTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

A name for the attribute.

\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\n

The data type for the attribute.

\n ", "required": true } }, "documentation": "\n

Represents an attribute for describing the key schema for the table and indexes.

\n " }, "documentation": "\n

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n \n " }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the table:

\n \n " }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the table was created, in UNIX epoch time format.

\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

Represents the name of the local secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a local secondary index.

\n " }, "documentation": "\n

Represents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "GlobalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).

\n " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the global secondary index:

\n \n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

Represents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a global secondary index.

\n " }, "documentation": "\n

The global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " } }, "documentation": "\n

Represents the properties of a table.

\n " } }, "documentation": "\n

Represents the output of a DeleteTable operation.

\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being attempted to be changed is in use.

\n " } }, "documentation": "\n

The operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Too many operations for a given subscriber.

\n " } }, "documentation": "\n

The number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.

\n

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

\n

The total limit of tables in the ACTIVE state is 250.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the DELETING state until\n Amazon DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete\n it. If a table is in CREATING or UPDATING states, then Amazon DynamoDB returns\n a ResourceInUseException. If the specified table does not exist, Amazon DynamoDB returns a\n ResourceNotFoundException. If table is already in the DELETING state, no\n error is returned.

\n \n

Amazon DynamoDB might continue to accept data read and write operations, such as GetItem and\n PutItem, on a table in the DELETING state until the table deletion is\n complete.

\n \n

When you delete a table, any indexes on that table are also deleted.

\n \n

Use the DescribeTable API to check the status of the table.

\n\n \n \n Delete a Table\n This example deletes the Reply table.\n \n{\n \"TableDescription\": {\n \"ItemCount\": 0,\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Reply\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"DELETING\"\n }\n}\n \n \n \n " }, "DescribeTable": { "name": "DescribeTable", "input": { "shape_name": "DescribeTableInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table to describe.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DescribeTable operation.

\n " }, "output": { "shape_name": "DescribeTableOutput", "type": "structure", "members": { "Table": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

A name for the attribute.

\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\n

The data type for the attribute.

\n ", "required": true } }, "documentation": "\n

Represents an attribute for describing the key schema for the table and indexes.

\n " }, "documentation": "\n

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n \n " }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the table:

\n \n " }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the table was created, in UNIX epoch time format.

\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

Represents the name of the local secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a local secondary index.

\n " }, "documentation": "\n

Represents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "GlobalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).

\n " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the global secondary index:

\n \n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

Represents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a global secondary index.

\n " }, "documentation": "\n

The global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " } }, "documentation": "\n

Represents the properties of a table.

\n " } }, "documentation": "\n

Represents the output of a DescribeTable operation.

\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Returns information about the table, including the current status of the table, when it was\n created, the primary key schema, and any indexes on the table.

\n \n \n Describe a Table\n \n

This example describes the Thread table.

\n \n \n{\n \"Table\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.363729002358E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"ACTIVE\"\n }\n}\n \n \n \n " }, "GetItem": { "name": "GetItem", "input": { "shape_name": "GetItemInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table containing the requested item.

\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "

The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.

\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "

If set to true, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.

\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " } }, "documentation": "\n

Represents the input of a GetItem operation.

\n " }, "output": { "shape_name": "GetItemOutput", "type": "structure", "members": { "Item": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute names to AttributeValue objects, as specified by AttributesToGet.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " } }, "documentation": "\n

Represents the output of a GetItem operation.

\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The GetItem operation returns a set of attributes for the item with the given primary\n key. If there is no matching item, GetItem does not return any data.

\n

GetItem provides an eventually consistent read by default. If your application\n requires a strongly consistent read, set ConsistentRead to true. Although\n a strongly consistent read might take more time than an eventually consistent read, it always\n returns the last updated value.

\n \n \n Retrieve Item Attributes\n This example retrieves three attributes from the Thread table. In the response,\n the ConsumedCapacityUnits value is 1, because ConsistentRead is set to true. If\n ConsistentRead had been set to false (or not specified) for the same request, an\n eventually consistent read would have been used and ConsumedCapacityUnits would have been\n 0.5.\n \n{\n \"ConsumedCapacity\": {\n \"CapacityUnits\": 1,\n \"TableName\": \"Thread\"\n },\n \"Item\": {\n \"Tags\": {\n \"SS\": [\"Update\",\"Multiple Items\",\"HelpMe\"]\n },\n \"LastPostDateTime\": {\n \"S\": \"201303190436\"\n },\n \"Message\": {\n \"S\": \"I want to update multiple items in a single API call. What's the best way to do that?\"\n }\n }\n}\n \n \n \n " }, "ListTables": { "name": "ListTables", "input": { "shape_name": "ListTablesInput", "type": "structure", "members": { "ExclusiveStartTableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that starts the list. If you already ran a ListTables operation\n and received a LastEvaluatedTableName value in the response, use that value here to\n continue the list.

\n " }, "Limit": { "shape_name": "ListTablesInputLimit", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

A maximum number of table names to return.

\n " } }, "documentation": "\n

Represents the input of a ListTables operation.

\n " }, "output": { "shape_name": "ListTablesOutput", "type": "structure", "members": { "TableNames": { "shape_name": "TableNameList", "type": "list", "members": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "documentation": "\n

The names of the tables associated with the current account at the current endpoint.

\n " }, "LastEvaluatedTableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the last table in the current list, only if some tables for the account and\n endpoint have not been returned. This value does not exist in a response if all table names\n are already returned. Use this value as the ExclusiveStartTableName in a new request to\n continue the list until all the table names are returned.

\n " } }, "documentation": "\n

Represents the output of a ListTables operation.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Returns an array of all the tables associated with the current account and endpoint.

\n \n \n List Tables\n \n

This example requests a list of tables, starting with a table named comp2 and ending\n after three table names have been returned.

\n \n \n{\n \"LastEvaluatedTableName\": \"Thread\",\n \"TableNames\": [\"Forum\",\"Reply\",\"Thread\"]\n}\n \n \n \n " }, "PutItem": { "name": "PutItem", "input": { "shape_name": "PutItemInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table to contain the item.

\n ", "required": true }, "Item": { "shape_name": "PutItemInputAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for the\n item.

\n

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

\n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

\n

Each element in the Item map is an AttributeValue object.

\n ", "required": true }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

\n \n

The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.

\n

Amazon DynamoDB returns a ValidationException if:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n " } }, "documentation": "\n

Represents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.

\n " }, "documentation": "\n

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.

\n

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n \n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\n

Use ReturnValues if you want to get the item attributes as they appeared before they were updated\n with the PutItem request. For PutItem, the valid values are:

\n \n\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " }, "ReturnItemCollectionMetrics": { "shape_name": "ReturnItemCollectionMetrics", "type": "string", "enum": [ "SIZE", "NONE" ], "documentation": "

If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

\n " } }, "documentation": "\n

Represents the input of a PutItem operation.

\n " }, "output": { "shape_name": "PutItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The attribute values as they appeared before the PutItem operation, but only if \n ReturnValues is specified as ALL_OLD in the request. Each\n element consists of an attribute name and an attribute value.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The hash key value of the item collection. This is the same as the hash key of the item.

\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\n

An estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

\n " } }, "documentation": "

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.

\n

Each ItemCollectionMetrics\n element consists of:

\n \n " } }, "documentation": "\n

Represents the output of a PutItem operation.

\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The conditional request failed.

\n " } }, "documentation": "\n

A condition specified in the operation could not be evaluated.

\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "ItemCollectionSizeLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

\n " } }, "documentation": "\n

An item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Creates a new item, or replaces an old item with a new item. If an item already exists in the\n specified table with the same primary key, the new item completely replaces the existing item.\n You can perform a conditional put (insert a new item if one with the specified primary key\n doesn't exist), or replace an existing item if it has certain attribute values.

\n

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

\n

When you add an item, the primary key attribute(s) are the only required attributes.\n Attribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes cannot be empty. Requests with empty values will be\n rejected with a ValidationException.

\n

You can request that PutItem return either a copy of the old item (before the update)\n or a copy of the new item (after the update). For more information, see the\n ReturnValues description.

\n \n

To prevent a new item from replacing an existing item, use a conditional put\n operation with Exists set to false for the primary key attribute, or\n attributes.

\n \n

For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

\n \n \n Put an Item\n \n

This example puts a new item into the Thread table. To prevent this new item from overwriting an existing item, \"Exists\" is set to false for the primary key attributes.

\n\n \n{\n}\n \n \n \n " }, "Query": { "name": "Query", "input": { "shape_name": "QueryInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table containing the requested items.

\n ", "required": true }, "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of an index to query. This can be any local secondary index or global secondary index on the table.

\n " }, "Select": { "shape_name": "Select", "type": "string", "enum": [ "ALL_ATTRIBUTES", "ALL_PROJECTED_ATTRIBUTES", "SPECIFIC_ATTRIBUTES", "COUNT" ], "documentation": "\n

The attributes to be returned in the result. You can\n retrieve all item attributes, specific item attributes, the count \n of matching items, or in the case of an index, some or all of the \n attributes projected into the index.

\n \n

If neither Select nor AttributesToGet are specified, Amazon DynamoDB\n defaults to ALL_ATTRIBUTES when accessing a table, and \n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single\n request, unless the value for Select\n is SPECIFIC_ATTRIBUTES. (This usage is equivalent to \n specifying AttributesToGet without any value for Select.)

\n " }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "

The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.

\n \n

If you are querying an index and request only attributes that are projected into that\n index, the operation will read only the index and not the table. If any of the requested\n attributes are not projected into the index, Amazon DynamoDB will need to fetch each\n matching item from the table. This extra fetching incurs additional throughput cost and\n latency.

\n\n

You cannot use both AttributesToGet and Select together in a Query\n request, unless the value for Select is SPECIFIC_ATTRIBUTES.\n (This usage is equivalent to specifying AttributesToGet without any value for\n Select.)

\n " }, "Limit": { "shape_name": "PositiveIntegerObject", "type": "integer", "min_length": 1, "documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items). If\n Amazon DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a LastEvaluatedKey to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to\n continue the operation. For more information see Query and Scan in the Amazon DynamoDB Developer Guide.

\n " }, "ConsistentRead": { "shape_name": "ConsistentRead", "type": "boolean", "documentation": "

If set to true, then the operation uses strongly consistent reads; otherwise, eventually\n consistent reads are used.

\n \n

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with\n ConsistentRead set to true, you will receive an error message.

\n " }, "KeyConditions": { "shape_name": "KeyConditions", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "Condition", "type": "structure", "members": { "AttributeValueList": { "shape_name": "AttributeValueList", "type": "list", "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

One or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN or IN comparison, in which\n case the list contains two values.

\n \n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.

\n \n " }, "ComparisonOperator": { "shape_name": "ComparisonOperator", "type": "string", "enum": [ "EQ", "NE", "IN", "LE", "LT", "GE", "GT", "BETWEEN", "NOT_NULL", "NULL", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH" ], "documentation": "\n

A comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.

Valid comparison operators for Query:

\n

EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

\n

Valid comparison operators for Scan:

\n

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

\n

For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.

\n

The following are descriptions of each comparison operator.

\n \n ", "required": true } }, "documentation": "\n

Represents a selection criteria for a Query or Scan operation.

\n \n

Multiple conditions are \"ANDed\" together. In other words, all of the conditions must be met\n to be included in the output.

\n " }, "documentation": "\n

The selection criteria for the query.

\n

For a query on a table, you can only have conditions on the table primary key attributes. You\n must specify the hash key attribute name and value as an EQ condition. You can\n optionally specify a second condition, referring to the range key attribute.

\n

For a query on an index, you can only have conditions on the index key attributes.\n You must specify the index hash attribute name and value as an EQ condition. You can\n optionally specify a second condition, referring to the index key range attribute.

\n

Multiple conditions are evaluated using \"AND\"; in other words, all of the conditions must be met in order for an item to appear in the results results.

\n

Each KeyConditions element consists of an attribute name to compare, along with the following:

\n \n " }, "ScanIndexForward": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

Specifies ascending (true) or descending (false) traversal of the index. Amazon DynamoDB returns results reflecting\n the requested order determined by the range key. If the data type is Number, the results are returned in numeric order. For String, the results are returned in order of ASCII character code values. For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

\n

If ScanIndexForward is not specified, the results are returned in ascending order.

\n " }, "ExclusiveStartKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "

The primary key of the first item that this operation will evalute. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " } }, "documentation": "\n

Represents the input of a Query operation.

\n " }, "output": { "shape_name": "QueryOutput", "type": "structure", "members": { "Items": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": null }, "documentation": "\n

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

\n " }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of items in the response.

\n " }, "LastEvaluatedKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "

The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is null, then the \"last page\" of results has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " } }, "documentation": "\n

Represents the output of a Query operation.

\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

A Query operation directly accesses items from a table using the table primary key, or\n from an index using the index key. You must provide a specific hash key value. You can narrow\n the scope of the query by using comparison operators on the range key value, or on the index\n key. You can use the ScanIndexForward parameter to get results in forward or reverse\n order, by range key or by index key.

\n

Queries that do not return results consume the minimum read capacity units according to the\n type of read.

\n

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query\n stops and results are returned to the user with a LastEvaluatedKey to continue the\n query in a subsequent operation. Unlike a Scan operation, a Query operation\n never returns an empty result set and a LastEvaluatedKey. The\n LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used\n Limit.

\n

You can query a table, a local secondary index (LSI), or a global secondary index (GSI). For a query on a table or on an LSI, you can set ConsistentRead to true and obtain a strongly consistent result. GSIs support eventually consistent reads only, so do not specify ConsistentRead when querying a GSI.

\n \n \n Retrieving a Range of Items\n \n

This example queries the Thread table for postings between two dates. There is an index on\n LastPostDateTime to facilitate fast lookups on this attribute.

\n

All of the attributes will be returned. Any attributes that are not projected into the\n index will cause Amazon DynamoDB to fetch those attributes from the Thread table;\n this fetching occurs automatically.

\n \n \n{\n \"Count\":`17\n}\n \n \n \n " }, "Scan": { "name": "Scan", "input": { "shape_name": "ScanInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table containing the requested items.

\n ", "required": true }, "AttributesToGet": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "min_length": 1, "documentation": "

The names of one or more attributes to retrieve. If no attribute\n names are specified, then all attributes will be returned. If\n any of the requested attributes are not found, they will not\n appear in the result.

\n " }, "Limit": { "shape_name": "PositiveIntegerObject", "type": "integer", "min_length": 1, "documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items). If\n Amazon DynamoDB processes the number of items up to the limit while processing the results, it stops the\n operation and returns the matching values up to that point, and a LastEvaluatedKey to \n apply in\n a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size\n exceeds 1 MB before Amazon DynamoDB reaches this limit, it stops the operation and returns the matching values\n up to the limit, and a LastEvaluatedKey to apply in a subsequent operation to\n continue the operation. For more information see Query and Scan in the Amazon DynamoDB Developer Guide.

\n " }, "Select": { "shape_name": "Select", "type": "string", "enum": [ "ALL_ATTRIBUTES", "ALL_PROJECTED_ATTRIBUTES", "SPECIFIC_ATTRIBUTES", "COUNT" ], "documentation": "\n

The attributes to be returned in the result. You can\n retrieve all item attributes, specific item attributes, or the count \n of matching items.

\n \n

If neither Select nor AttributesToGet are specified, Amazon DynamoDB\n defaults to ALL_ATTRIBUTES. You cannot use both Select and AttributesToGet together in a single\n request, unless the value for Select\n is SPECIFIC_ATTRIBUTES. (This usage is equivalent to \n specifying AttributesToGet without any value for Select.)

\n " }, "ScanFilter": { "shape_name": "FilterConditionMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "Condition", "type": "structure", "members": { "AttributeValueList": { "shape_name": "AttributeValueList", "type": "list", "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

One or more values to evaluate against the supplied attribute. This list contains\n exactly one value, except for a BETWEEN or IN comparison, in which\n case the list contains two values.

\n \n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n aa is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary\n values, for example when evaluating query expressions.

\n \n " }, "ComparisonOperator": { "shape_name": "ComparisonOperator", "type": "string", "enum": [ "EQ", "NE", "IN", "LE", "LT", "GE", "GT", "BETWEEN", "NOT_NULL", "NULL", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH" ], "documentation": "\n

A comparator for evaluating attributes. For example, equals, greater than, less\n than, etc.

Valid comparison operators for Query:

\n

EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

\n

Valid comparison operators for Scan:

\n

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

\n

For\n information on specifying data types in JSON, see JSON\n Data Format in the Amazon DynamoDB Developer Guide.

\n

The following are descriptions of each comparison operator.

\n \n ", "required": true } }, "documentation": "\n

Represents a selection criteria for a Query or Scan operation.

\n \n

Multiple conditions are \"ANDed\" together. In other words, all of the conditions must be met\n to be included in the output.

\n " }, "documentation": "\n

Evaluates the scan results and returns only the desired values. Multiple conditions are\n treated as \"AND\" operations: all conditions must be met to be included in the results.

\n

Each ScanConditions element consists of an attribute name to compare, along with the following:

\n \n " }, "ExclusiveStartKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "

The primary key of the first item that this operation will evalute. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

\n \n

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

\n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " }, "TotalSegments": { "shape_name": "ScanTotalSegments", "type": "integer", "min_length": 1, "max_length": 4096, "documentation": "\n

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments\n corresponds to the number of application workers that will\n perform the parallel scan. For example, if you want to scan a table using four\n application threads, you would specify a TotalSegments value of 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 4096. If you specify a TotalSegments value of 1, the Scan will be sequential\n rather than parallel.

\n

If you specify TotalSegments, you must also specify Segment.

\n" }, "Segment": { "shape_name": "ScanSegment", "type": "integer", "min_length": 0, "max_length": 4095, "documentation": "\n

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

\n

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to\n scan a table using four application threads, the first thread would specify a Segment\n value of 0, the second thread would specify 1, and so on.

\n

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same Segment ID in a subsequent Scan operation.

\n

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

\n

If you specify Segment, you must also specify TotalSegments.

\n " } }, "documentation": "\n

Represents the input of a Scan operation.

\n " }, "output": { "shape_name": "ScanOutput", "type": "structure", "members": { "Items": { "shape_name": "ItemList", "type": "list", "members": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": null }, "documentation": "\n

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

\n " }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of items in the response.

\n " }, "ScannedCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of items in the complete scan, before any filters are applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

\n\n " }, "LastEvaluatedKey": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "

The primary key of the item where the operation\n stopped, inclusive of the previous result set. Use this value to\n start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is null, then the \"last page\" of results has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is anything other than null, this does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is null.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " } }, "documentation": "\n

Represents the output of a Scan operation.

\n " }, "errors": [ { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

The Scan operation returns one or more items and item attributes by accessing every item in the table. To have Amazon DynamoDB return fewer items, you can provide a ScanFilter.

\n\n

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are\n returned to the user with a LastEvaluatedKey to continue the scan in a subsequent\n operation. The results also include the number of items exceeding the limit. A scan can result\n in no table data meeting the filter criteria.

\n

The result set is eventually consistent.

\n

By default, Scan operations proceed sequentially; however, for faster performance on\n large tables, applications can request a parallel Scan by specifying the Segment\n and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

\n \n \n Returning All Items\n This example returns all of the items in a table. No scan filter is\n applied.\n \n{\n \"ConsumedCapacity\": {\n \"CapacityUnits\": 0.5,\n \"TableName\": \"Reply\"\n },\n \"Count\": 2,\n \"Items\": [\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115336\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"Have you looked at the BatchWriteItem API?\"\n }\n },\n {\n \"PostedBy\": {\n \"S\": \"joe@example.com\"\n },\n \"ReplyDateTime\": {\n \"S\": \"20130320115347\"\n },\n \"Id\": {\n \"S\": \"Amazon DynamoDB#How do I update multiple items?\"\n },\n \"Message\": {\n \"S\": \"BatchWriteItem is documented in the Amazon DynamoDB API Reference.\"\n }\n }\n ],\n \"ScannedCount\": 4\n}\n \n \n \n " }, "UpdateItem": { "name": "UpdateItem", "input": { "shape_name": "UpdateItemInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table containing the item to update.

\n ", "required": true }, "Key": { "shape_name": "Key", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

\n ", "required": true }, "AttributeUpdates": { "shape_name": "AttributeUpdates", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValueUpdate", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "Action": { "shape_name": "AttributeAction", "type": "string", "enum": [ "ADD", "PUT", "DELETE" ], "documentation": "\n

Specifies how to perform the update. Valid values are PUT, DELETE,\n and ADD. The behavior depends on whether the specified primary key already exists\n in the table.

\n \n

\n If an item with the specified Key is found in the table:\n

\n \n \n \n

\n If no item with the specified Key is found:\n

\n \n \n " } }, "documentation": "\n

For the UpdateItem operation, represents the attributes to be modified,the action to perform on each, and the new value for each.

\n \n

You cannot use UpdateItem to update any primary key attributes. Instead, you will\n need to delete the item, and then use PutItem to create a new item with new\n attributes.

\n \n

Attribute values cannot be null; string and binary type attributes must have lengths greater\n than zero; and set type attributes must not be empty. Requests with empty values will be\n rejected with a ValidationException.

\n " }, "documentation": "\n

The names of attributes to be modified, the action to perform on each, and the new value for\n each. If you are updating an attribute that is an index key attribute for any indexes on that\n table, the attribute type must match the index key type defined in the AttributesDefinition of\n the table description. You can use UpdateItem to update any non-key attributes.

\n

Attribute values cannot be null. String and binary type attributes must have lengths greater\n than zero. Set type attributes must not be empty. Requests with empty values will be\n rejected with a ValidationException.

\n

Each AttributeUpdates element consists of an attribute name to modify, along with the\n following:

\n \n

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

\n " }, "Expected": { "shape_name": "ExpectedAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "ExpectedAttributeValue", "type": "structure", "members": { "Value": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "Exists": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

Causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

\n \n

The default setting for Exists is true. If you supply a Value all\n by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.

\n

Amazon DynamoDB returns a ValidationException if:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n " } }, "documentation": "\n

Represents an attribute value used with conditional DeleteItem, PutItem or UpdateItem operations. Amazon DynamoDB will check to see if the attribute value already exists; or if the attribute exists and has a particular value before updating it.

\n " }, "documentation": "\n

A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation. All the conditions must be met for the operation to succeed.

\n

Expected allows you to\n provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value\n already exists; or if the attribute value exists and has a particular value before changing\n it.

\n

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with\n the following:

\n \n

If you specify more than one condition for Exists, then all of the conditions must\n evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the\n conditional operation will fail.

\n\n " }, "ReturnValues": { "shape_name": "ReturnValue", "type": "string", "enum": [ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ], "documentation": "\n

Use ReturnValues if you want to get the item attributes as they appeared either before\n or after they were updated. For UpdateItem, the valid values are:

\n \n " }, "ReturnConsumedCapacity": { "shape_name": "ReturnConsumedCapacity", "type": "string", "enum": [ "INDEXES", "TOTAL", "NONE" ], "documentation": "\n

If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the repsonse includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

\n " }, "ReturnItemCollectionMetrics": { "shape_name": "ReturnItemCollectionMetrics", "type": "string", "enum": [ "SIZE", "NONE" ], "documentation": "

If set to SIZE, statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

\n " } }, "documentation": "\n

Represents the input of an UpdateItem operation.

\n " }, "output": { "shape_name": "UpdateItemOutput", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

A map of attribute values as they appeared before the UpdateItem operation, but only if\n ReturnValues was specified as something other than NONE in\n the request. Each element represents one attribute.

\n " }, "ConsumedCapacity": { "shape_name": "ConsumedCapacity", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table that was affected by the operation.

\n " }, "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed by the operation.

\n " }, "Table": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

The amount of throughput consumed on the table affected by the operation.

\n " }, "LocalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each local index affected by the operation.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "SecondaryIndexesCapacityMap", "type": "map", "keys": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "members": { "shape_name": "Capacity", "type": "structure", "members": { "CapacityUnits": { "shape_name": "ConsumedCapacityUnits", "type": "double", "documentation": "\n

The total number of capacity units consumed on a table or an index.

\n " } }, "documentation": "\n

Represents the amount of provisioned throughput capacity consumed on a table or an index.

\n " }, "documentation": "\n

The amount of throughput consumed on each global index affected by the operation.

\n " } }, "documentation": "\n

Represents the capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

\n " }, "ItemCollectionMetrics": { "shape_name": "ItemCollectionMetrics", "type": "structure", "members": { "ItemCollectionKey": { "shape_name": "ItemCollectionKeyAttributeMap", "type": "map", "keys": { "shape_name": "AttributeName", "type": "string", "documentation": null }, "members": { "shape_name": "AttributeValue", "type": "structure", "members": { "S": { "shape_name": "StringAttributeValue", "type": "string", "documentation": "\n

A String data type

\n " }, "N": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": "\n

A Number data type

\n " }, "B": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": "\n

A Binary data type

\n " }, "SS": { "shape_name": "StringSetAttributeValue", "type": "list", "members": { "shape_name": "StringAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

A String set data type

\n " }, "NS": { "shape_name": "NumberSetAttributeValue", "type": "list", "members": { "shape_name": "NumberAttributeValue", "type": "string", "documentation": null }, "documentation": "\n

Number set data type

\n " }, "BS": { "shape_name": "BinarySetAttributeValue", "type": "list", "members": { "shape_name": "BinaryAttributeValue", "type": "blob", "documentation": null }, "documentation": "\n

A Binary set data type

\n " } }, "documentation": "\n

Represents the data for an attribute. You can set one, and only one, of the elements.

\n " }, "documentation": "\n

The hash key value of the item collection. This is the same as the hash key of the item.

\n " }, "SizeEstimateRangeGB": { "shape_name": "ItemCollectionSizeEstimateRange", "type": "list", "members": { "shape_name": "ItemCollectionSizeEstimateBound", "type": "double", "documentation": null }, "documentation": "\n

An estimate of item collection size, measured in gigabytes. This is a\n two-element array containing a lower bound and an upper bound for the estimate. The estimate\n includes the size of all the items in the table, plus the size of all attributes projected\n into all of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

\n " } }, "documentation": "\n

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if it was asked for in the request. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n " } }, "documentation": "\n

Represents the output of an UpdateItem operation.

\n " }, "errors": [ { "shape_name": "ConditionalCheckFailedException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The conditional request failed.

\n " } }, "documentation": "\n

A condition specified in the operation could not be evaluated.

\n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

You exceeded your maximum allowed provisioned throughput.

\n " } }, "documentation": "\n

The request rate is too high, or the request is too large, for the available throughput to\n accommodate. The AWS SDKs automatically retry requests that receive this exception;\n therefore, your request will eventually succeed, unless the request is too large or your retry\n queue is too large to finish. Reduce the frequency of requests by using the strategies listed in\n Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "ItemCollectionSizeLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

\n " } }, "documentation": "\n

An item collection is too large. This exception is only returned for tables that have one or\n more local secondary indexes.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can\n also perform a conditional update (insert a new attribute name-value pair if it doesn't exist,\n or replace an existing name-value pair if it has certain expected attribute values).

\n

In addition to updating an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

\n \n \n Conditional Update\n \n

This example updates the Thread table, changing the LastPostedBy attribute-but\n only if LastPostedBy is currently \"fred@example.com\". All of the item's attributes, as\n they appear after the update, are returned in the response.

\n \n \n{ \n}\n \n \n \n " }, "UpdateTable": { "name": "UpdateTable", "input": { "shape_name": "UpdateTableInput", "type": "structure", "members": { "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table to be updated.

\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "GlobalSecondaryIndexUpdates": { "shape_name": "GlobalSecondaryIndexUpdateList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexUpdate", "type": "structure", "members": { "Update": { "shape_name": "UpdateGlobalSecondaryIndexAction", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index to be updated.

\n ", "required": true }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughput", "type": "structure", "members": { "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

\n ", "required": true } }, "documentation": "\n

The name of a global secondary index, along with the updated provisioned throughput settings that are to be applied to that index.

\n " } }, "documentation": "\n

Represents the new provisioned throughput settings to apply to a global secondary index.

\n " }, "documentation": "\n

An array of one or more global secondary indexes on the table, together with provisioned throughput settings for each index.

\n " } }, "documentation": "\n

Represents the input of an UpdateTable operation.

\n " }, "output": { "shape_name": "UpdateTableOutput", "type": "structure", "members": { "TableDescription": { "shape_name": "TableDescription", "type": "structure", "members": { "AttributeDefinitions": { "shape_name": "AttributeDefinitions", "type": "list", "members": { "shape_name": "AttributeDefinition", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

A name for the attribute.

\n ", "required": true }, "AttributeType": { "shape_name": "ScalarAttributeType", "type": "string", "enum": [ "S", "N", "B" ], "documentation": "\n

The data type for the attribute.

\n ", "required": true } }, "documentation": "\n

Represents an attribute for describing the key schema for the table and indexes.

\n " }, "documentation": "\n

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n \n " }, "TableName": { "shape_name": "TableName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the table.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

\n " }, "TableStatus": { "shape_name": "TableStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the table:

\n \n " }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the table was created, in UNIX epoch time format.

\n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "TableSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified table, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified table. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "LocalSecondaryIndexes": { "shape_name": "LocalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "LocalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

Represents the name of the local secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "The complete index\n key schema, which consists of one or more pairs of attribute names and key types\n (HASH or RANGE). " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a local secondary index.

\n " }, "documentation": "\n

Represents one or more local secondary indexes on the table. Each index is scoped to a given\n hash key value. Tables with one or more local secondary indexes are subject to an item\n collection size limit, where the amount of data within a given item collection cannot exceed\n 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " }, "GlobalSecondaryIndexes": { "shape_name": "GlobalSecondaryIndexDescriptionList", "type": "list", "members": { "shape_name": "GlobalSecondaryIndexDescription", "type": "structure", "members": { "IndexName": { "shape_name": "IndexName", "type": "string", "min_length": 3, "max_length": 255, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the global secondary index.

\n " }, "KeySchema": { "shape_name": "KeySchema", "type": "list", "members": { "shape_name": "KeySchemaElement", "type": "structure", "members": { "AttributeName": { "shape_name": "KeySchemaAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of a key attribute.

\n ", "required": true }, "KeyType": { "shape_name": "KeyType", "type": "string", "enum": [ "HASH", "RANGE" ], "documentation": "\n

The attribute data, consisting of the data type and the attribute value\n itself.

\n ", "required": true } }, "documentation": "\n

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or\n the key attributes of an index.

\n " }, "min_length": 1, "max_length": 2, "documentation": "\n

The complete key schema for the global secondary index, consisting of one or more pairs of attribute names and key types\n (HASH or RANGE).

\n " }, "Projection": { "shape_name": "Projection", "type": "structure", "members": { "ProjectionType": { "shape_name": "ProjectionType", "type": "string", "enum": [ "ALL", "KEYS_ONLY", "INCLUDE" ], "documentation": "\n

The set of attributes that are projected into the index:

\n \n " }, "NonKeyAttributes": { "shape_name": "NonKeyAttributeNameList", "type": "list", "members": { "shape_name": "NonKeyAttributeName", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "min_length": 1, "max_length": 20, "documentation": "\n

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

\n " } }, "documentation": "\n

Represents attributes that are copied (projected) from the table into an index. These are in\n addition to the primary key attributes and index key attributes, which are automatically\n projected.

\n " }, "IndexStatus": { "shape_name": "IndexStatus", "type": "string", "enum": [ "CREATING", "UPDATING", "DELETING", "ACTIVE" ], "documentation": "\n

The current state of the global secondary index:

\n \n " }, "ProvisionedThroughput": { "shape_name": "ProvisionedThroughputDescription", "type": "structure", "members": { "LastIncreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput increase for this table.

\n " }, "LastDecreaseDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time of the last provisioned throughput decrease for this table.

\n " }, "NumberOfDecreasesToday": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

\n " }, "ReadCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

\n " }, "WriteCapacityUnits": { "shape_name": "PositiveLongObject", "type": "long", "min_length": 1, "documentation": "\n

The maximum number of writes consumed per second before Amazon DynamoDB returns a\n ThrottlingException.

\n " } }, "documentation": "\n

Represents the provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

\n " }, "IndexSizeBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

The total size of the specified index, in bytes. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " }, "ItemCount": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of items in the specified index. Amazon DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.\n

\n " } }, "documentation": "\n

Represents the properties of a global secondary index.

\n " }, "documentation": "\n

The global secondary indexes, if any, on the table. Each index is scoped to a given\n hash key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be returned.

\n " } }, "documentation": "\n

Represents the properties of a table.

\n " } }, "documentation": "\n

Represents the output of an UpdateTable operation.

\n " }, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being attempted to be changed is in use.

\n " } }, "documentation": "\n

The operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The resource which is being requested does not exist.

\n " } }, "documentation": "\n

The operation tried to access a nonexistent table or index. The resource may not be specified correctly, or its status may not be ACTIVE.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Too many operations for a given subscriber.

\n " } }, "documentation": "\n

The number of concurrent table requests (cumulative number of tables in the\n CREATING, DELETING or UPDATING state) exceeds the\n maximum allowed of 10.

\n

Also, for tables with secondary indexes, only one of those tables can be in the CREATING state at any point in time. Do not attempt to create more than one such table simultaneously.

\n

The total limit of tables in the ACTIVE state is 250.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The server encountered an internal error trying to fulfill the request.

\n " } }, "documentation": "\n

An error occurred on the server side.

\n " } ], "documentation": "\n

Updates the provisioned throughput for the given table. Setting the throughput for a table\n helps you manage performance and is part of the provisioned throughput feature of Amazon DynamoDB.

\n

The provisioned throughput values can be upgraded or downgraded based on the maximums and\n minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.

\n

The table must be in the ACTIVE state for this operation to succeed.\n UpdateTable is an asynchronous operation; while executing the operation, the table is\n in the UPDATING state. While the table is in the UPDATING state, the\n table still has the provisioned throughput from before the call. The new provisioned\n throughput setting is in effect only when the table returns to the ACTIVE state\n after the UpdateTable operation.

\n

You cannot add, modify or delete indexes using UpdateTable. Indexes can only be defined at table creation time.

\n\n \n \n Modify Provisioned Write Throughput\n \n

This example changes both the provisioned read and write throughput of the Thread table to\n 10 capacity units.

\n \n \n{ \n \"TableDescription\": {\n \"AttributeDefinitions\": [\n {\n \"AttributeName\": \"ForumName\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"AttributeType\": \"S\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"AttributeType\": \"S\"\n }\n ],\n \"CreationDateTime\": 1.363801528686E9,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"Subject\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"LocalSecondaryIndexes\": [\n {\n \"IndexName\": \"LastPostIndex\",\n \"IndexSizeBytes\": 0,\n \"ItemCount\": 0,\n \"KeySchema\": [\n {\n \"AttributeName\": \"ForumName\",\n \"KeyType\": \"HASH\"\n },\n {\n \"AttributeName\": \"LastPostDateTime\",\n \"KeyType\": \"RANGE\"\n }\n ],\n \"Projection\": {\n \"ProjectionType\": \"KEYS_ONLY\"\n }\n }\n ],\n \"ProvisionedThroughput\": {\n \"LastIncreaseDateTime\": 1.363801701282E9,\n \"NumberOfDecreasesToday\": 0,\n \"ReadCapacityUnits\": 5,\n \"WriteCapacityUnits\": 5\n },\n \"TableName\": \"Thread\",\n \"TableSizeBytes\": 0,\n \"TableStatus\": \"UPDATING\"\n }\n}\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://dynamodb.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "waiters": { "TableNotExists": { "success": { "type": "error", "value": [ "ResourceNotFoundException" ] }, "interval": 20, "operation": "DescribeTable", "max_attempts": 25 }, "TableExists": { "success": { "path": "Table.TableStatus", "type": "output", "value": [ "ACTIVE" ] }, "interval": 20, "ignore_errors": [ "ResourceNotFoundException" ], "operation": "DescribeTable", "max_attempts": 25 } }, "retry": { "__default__": { "max_attempts": 10, "delay": { "type": "exponential", "base": 0.05, "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throughput_exceeded": { "applies_when": { "response": { "service_error_code": "ProvisionedThroughputExceededException", "http_status_code": 400 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "ThrottlingException", "http_status_code": 400 } } }, "crc32": { "applies_when": { "response": { "crc32body": "x-amz-crc32" } } } } } } }botocore-0.29.0/botocore/data/aws/ec2.json0000644000175000017500000506561712254746566017640 0ustar takakitakaki{ "api_version": "2013-10-15", "type": "query", "result_wrapped": false, "signature_version": "v2", "service_full_name": "Amazon Elastic Compute Cloud", "service_abbreviation": "Amazon EC2", "endpoint_prefix": "ec2", "xmlnamespace": "http://ec2.amazonaws.com/doc/2013-10-15/", "documentation": "\n

\n Amazon Elastic Compute Cloud (Amazon EC2) is a web service that provides\n resizable compute capacity in the cloud.\n It is designed to make web-scale computing easier for developers.\n

\n

\n Amazon EC2's simple web service interface allows you to obtain and configure\n capacity with minimal friction. It provides you with complete control of your\n computing resources and lets you run on Amazon's proven computing environment.\n Amazon EC2 reduces the time required to obtain and boot new server instances to\n minutes, allowing you to quickly scale capacity, both up and down, as your\n computing requirements change. Amazon EC2 changes the economics of computing by\n allowing you to pay only for capacity that you actually use. Amazon EC2 provides\n developers the tools to build failure resilient applications and isolate\n themselves from common failure scenarios.\n

\n

\n Visit http://aws.amazon.com/ec2/ for\n more information.\n

\n ", "operations": { "ActivateLicense": { "name": "ActivateLicense", "input": { "shape_name": "ActivateLicenseRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "LicenseId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID for the specific license to activate against.\n

\n ", "required": true }, "Capacity": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the additional number of licenses to activate.\n

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Activates a specific number of licenses for a 90-day period.\n Activations can be done against a specific license ID.\n

\n " }, "AllocateAddress": { "name": "AllocateAddress", "input": { "shape_name": "AllocateAddressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Domain": { "shape_name": "DomainType", "type": "string", "enum": [ "vpc", "standard" ], "documentation": "\n

\n Set to vpc to allocate the address to your VPC. By default, will allocate to EC2.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "AllocateAddressResult", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n IP address for use with your account.\n

\n ", "xmlname": "publicIp" }, "Domain": { "shape_name": "DomainType", "type": "string", "enum": [ "vpc", "standard" ], "documentation": null, "xmlname": "domain" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" } }, "documentation": "\n

\n Result returned from allocating an Elastic IP.\n

\n " }, "errors": [], "documentation": "\n

\n The AllocateAddress operation acquires an elastic IP address for use with your\n account.\n

\n " }, "AssignPrivateIpAddresses": { "name": "AssignPrivateIpAddresses", "input": { "shape_name": "AssignPrivateIpAddressesRequest", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "PrivateIpAddress" }, "documentation": null, "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null }, "AllowReassignment": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "AssociateAddress": { "name": "AssociateAddress", "input": { "shape_name": "AssociateAddressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The instance to associate with the IP address.\n

\n " }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n IP address that you are assigning to the instance.\n

\n " }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allocation ID that AWS returned when you allocated the elastic IP address for use with Amazon VPC.\n

\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null }, "AllowReassociation": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": "\n

\n Associates an elastic IP address with an instance. If the IP address is\n currently assigned to another instance, the IP address is\n assigned to the new instance.\n

\n

\n This is an idempotent operation. If you enter it more than once, Amazon\n EC2 does not return an error.\n

\n " }, "output": { "shape_name": "AssociateAddressResult", "type": "structure", "members": { "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null }, "errors": [], "documentation": "\n

\n The AssociateAddress operation associates an elastic IP address with an\n instance.\n

\n

\n If the IP address is currently assigned to another instance, the IP address is\n assigned to the new instance. This is an idempotent operation. If you enter it\n more than once, Amazon EC2 does not return an error.\n

\n " }, "AssociateDhcpOptions": { "name": "AssociateDhcpOptions", "input": { "shape_name": "AssociateDhcpOptionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the DHCP options\n to associate with the VPC.\n Specify \"default\" to associate the\n default DHCP options with the VPC.\n

\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC to associate the DHCP options with.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Associates a set of DHCP options (that you've previously created) with the specified VPC. Or,\n associates the default DHCP options with the VPC. The default set consists of the standard EC2 host\n name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type.\n After you associate the options with the VPC, any existing instances and all new instances that you\n launch in that VPC use the options. For more information about the supported DHCP options and using\n them with Amazon VPC, go to Using DHCP Options in the Amazon Virtual Private Cloud Developer\n Guide.\n

\n " }, "AssociateRouteTable": { "name": "AssociateRouteTable", "input": { "shape_name": "AssociateRouteTableRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the subnet.\n

\n ", "required": true }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the route table.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "AssociateRouteTableResult", "type": "structure", "members": { "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null }, "errors": [], "documentation": "\n

\n\t\tAssociates a subnet with a route table. The subnet and route table must be in the same VPC.\n\t\tThis association causes traffic originating from the subnet to be routed according to the\n\t\troutes in the route table. The action returns an association ID, which you need if you want\n\t\tto disassociate the route table from the subnet later. A route table can be associated with\n\t\tmultiple subnets.\n\t\t

\n\t\t

\n\t\tFor more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n

\n " }, "AttachInternetGateway": { "name": "AttachInternetGateway", "input": { "shape_name": "AttachInternetGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InternetGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Internet gateway to attach.\n

\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC.\n\t\tFor more information about your VPC and Internet gateway, go to the Amazon Virtual Private Cloud\n\t\tUser Guide.\n

\n " }, "AttachNetworkInterface": { "name": "AttachNetworkInterface", "input": { "shape_name": "AttachNetworkInterfaceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "AttachNetworkInterfaceResult", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" } }, "documentation": null }, "errors": [], "documentation": null }, "AttachVolume": { "name": "AttachVolume", "input": { "shape_name": "AttachVolumeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Amazon EBS volume. The volume and instance must be within the\n same Availability Zone and the instance must be running.\n

\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance to which the volume attaches. The volume and instance must be within\n the same Availability Zone and the instance must be running.\n

\n ", "required": true }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies how the device is exposed to the instance (e.g., /dev/sdh).\n

\n ", "required": true } }, "documentation": "\n

\n Request to attach an Amazon EBS volume to a running instance and expose it as\n the specified device.\n

\n " }, "output": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n How the device is exposed to the instance (e.g., /dev/sdh).\n

\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when this attachment initiated.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n `

\n Whether this volume will be deleted or not when the associated instance is\n terminated.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n ", "xmlname": "attachment" }, "errors": [], "documentation": "\n

\n Attach a previously created volume to a running instance.\n

\n " }, "AttachVpnGateway": { "name": "AttachVpnGateway", "input": { "shape_name": "AttachVpnGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPN gateway to attach to the VPC.\n

\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC to attach to the VPN gateway.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "AttachVpnGatewayResult", "type": "structure", "members": { "VpcAttachment": { "shape_name": "VpcAttachment", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n\n

\n ", "xmlname": "attachment" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Attaches a VPN gateway to a VPC. This is the last step required to get your VPC fully connected\n to your data center before launching instances in it. For more information, go to Process for Using\n Amazon VPC in the Amazon Virtual Private Cloud Developer Guide.\n

\n " }, "AuthorizeSecurityGroupEgress": { "name": "AuthorizeSecurityGroupEgress", "input": { "shape_name": "AuthorizeSecurityGroupEgressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the VPC security group to modify.\n

\n ", "required": true }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n " }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n " }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n " }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "Groups" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "flattened": true }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n " } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n " }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "flattened": true } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n " }, "documentation": "\n

\n List of IP permissions to authorize on the specified security group. Specifying\n permissions through IP permissions is the preferred way of authorizing permissions\n since it offers more flexibility and control.\n

\n ", "flattened": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tThis action applies only to security groups in a VPC; it's not supported for EC2 security groups.\n\t\tFor information about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon\n\t\tVirtual Private Cloud User Guide.\n\t\t

\n\t\t

\n\t\tThe action adds one or more egress rules to a VPC security group. Specifically, this permits\n\t\tinstances in a security group to send traffic to either one or more destination CIDR IP address\n\t\tranges, or to one or more destination security groups in the same VPC.\n\t\t

\n\t\t

\n\t\tEach rule consists of the protocol (e.g., TCP), plus either a CIDR range, or a source group. For\n\t\tthe TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP\n\t\tprotocol, you must also specify the ICMP type and code. You can use -1 as a wildcard\n\t\tfor the ICMP type or code.\n\t\t

\n\t\t

\n\t\tRule changes are propagated to instances within the security group as quickly as possible. However,\n\t\ta small delay might occur.\n\t\t

\n\t\t

\n\t\tImportant: For VPC security groups: You can have up to 50 rules total per group (covering\n\t\tboth ingress and egress).\n\t\t

\n " }, "AuthorizeSecurityGroupIngress": { "name": "AuthorizeSecurityGroupIngress", "input": { "shape_name": "AuthorizeSecurityGroupIngressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.\n

\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n " }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n " }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n " }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "Groups" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "flattened": true }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n " } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n " }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "flattened": true } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n " }, "documentation": "\n

\n List of IP permissions to authorize on the specified security group. Specifying\n permissions through IP permissions is the preferred way of authorizing permissions\n since it offers more flexibility and control.\n

\n ", "flattened": true } }, "documentation": "\n

\n Request to adds permissions to a security group.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The AuthorizeSecurityGroupIngress operation adds permissions to a security\n group.\n

\n

\n Permissions are specified by the IP protocol (TCP, UDP or ICMP), the source of\n the request (by IP range or an Amazon EC2 user-group pair), the source and\n destination port ranges (for TCP and UDP), and the ICMP codes and types (for\n ICMP). When authorizing ICMP, -1 can be used as a wildcard in the type and code\n fields.\n

\n

\n Permission changes are propagated to instances within the security group as\n quickly as possible. However, depending on the number of instances, a small\n delay might occur.\n

\n " }, "BundleInstance": { "name": "BundleInstance", "input": { "shape_name": "BundleInstanceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance to bundle.\n

\n ", "required": true }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n The bucket in which to store the AMI. You can specify a bucket that you\n already own or a new bucket that Amazon EC2 creates on your\n behalf.\n

\n

\n If you specify a bucket that belongs to someone else, Amazon EC2 returns\n an error.\n

\n " }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix to use when storing the AMI in S3.\n

\n " }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Access Key ID of the owner of the Amazon S3 bucket.\n

\n " }, "UploadPolicy": { "shape_name": "String", "type": "blob", "documentation": "\n

\n A Base64-encoded Amazon S3 upload policy that gives Amazon EC2\n permission to upload items into Amazon S3 on the user's behalf.\n

\n " }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\n

\n The signature of the Base64 encoded JSON document.\n

\n " } }, "documentation": "\n

\n The details of S3 storage for bundling a Windows instance.\n

\n " } }, "documentation": "\n

\n\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "BundleInstanceResult", "type": "structure", "members": { "BundleTask": { "shape_name": "BundleTask", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Instance associated with this bundle task.\n

\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique identifier for this task.\n

\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": "\n

\n The state of this task.\n

\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time this task started.\n

\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time of the most recent update for the task.\n

\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n The bucket in which to store the AMI. You can specify a bucket that you\n already own or a new bucket that Amazon EC2 creates on your\n behalf.\n

\n

\n If you specify a bucket that belongs to someone else, Amazon EC2 returns\n an error.\n

\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix to use when storing the AMI in S3.\n

\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Access Key ID of the owner of the Amazon S3 bucket.\n

\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\n

\n A Base64-encoded Amazon S3 upload policy that gives Amazon EC2\n permission to upload items into Amazon S3 on the user's behalf.\n

\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\n

\n The signature of the Base64 encoded JSON document.\n

\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\n

\n The details of S3 storage for bundling a Windows instance.\n

\n " } }, "documentation": "\n

\n Amazon S3 storage locations.\n

\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\n

\n The level of task completion, in percent (e.g., 20%).\n

\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error code.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error message.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n If the task fails, a description of the error.\n

\n ", "xmlname": "error" } }, "documentation": "\n

\n\n

\n ", "xmlname": "bundleInstanceTask" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n The BundleInstance operation request that an instance is bundled the next time it boots.\n The bundling process creates a new image from a running instance and stores\n the AMI data in S3. Once bundled, the image must be registered in the normal\n way using the RegisterImage API.\n

\n " }, "CancelBundleTask": { "name": "CancelBundleTask", "input": { "shape_name": "CancelBundleTaskRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "BundleId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the bundle task to cancel.\n

\n ", "required": true } }, "documentation": "\n

\n A request to cancel an Amazon EC2 bundle task.\n

\n " }, "output": { "shape_name": "CancelBundleTaskResult", "type": "structure", "members": { "BundleTask": { "shape_name": "BundleTask", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Instance associated with this bundle task.\n

\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique identifier for this task.\n

\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": "\n

\n The state of this task.\n

\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time this task started.\n

\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time of the most recent update for the task.\n

\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n The bucket in which to store the AMI. You can specify a bucket that you\n already own or a new bucket that Amazon EC2 creates on your\n behalf.\n

\n

\n If you specify a bucket that belongs to someone else, Amazon EC2 returns\n an error.\n

\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix to use when storing the AMI in S3.\n

\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Access Key ID of the owner of the Amazon S3 bucket.\n

\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\n

\n A Base64-encoded Amazon S3 upload policy that gives Amazon EC2\n permission to upload items into Amazon S3 on the user's behalf.\n

\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\n

\n The signature of the Base64 encoded JSON document.\n

\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\n

\n The details of S3 storage for bundling a Windows instance.\n

\n " } }, "documentation": "\n

\n Amazon S3 storage locations.\n

\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\n

\n The level of task completion, in percent (e.g., 20%).\n

\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error code.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error message.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n If the task fails, a description of the error.\n

\n ", "xmlname": "error" } }, "documentation": "\n

\n The canceled bundle task.\n

\n ", "xmlname": "bundleInstanceTask" } }, "documentation": "\n

\n The result of canceling an Amazon EC2 bundle task.\n

\n " }, "errors": [], "documentation": "\n

\n CancelBundleTask operation cancels a pending or\n in-progress bundling task. This is an asynchronous\n call and it make take a while for the task to be canceled.\n If a task is canceled while it is storing items,\n there may be parts of the incomplete AMI stored in S3.\n It is up to the caller to clean up these parts from S3.\n

\n " }, "CancelConversionTask": { "name": "CancelConversionTask", "input": { "shape_name": "CancelConversionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ConversionTaskId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "ReasonMessage": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "CancelExportTask": { "name": "CancelExportTask", "input": { "shape_name": "CancelExportTaskRequest", "type": "structure", "members": { "ExportTaskId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "CancelReservedInstancesListing": { "name": "CancelReservedInstancesListing", "input": { "shape_name": "CancelReservedInstancesListingRequest", "type": "structure", "members": { "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CancelReservedInstancesListingResult", "type": "structure", "members": { "ReservedInstancesListings": { "shape_name": "ReservedInstancesListingList", "type": "list", "members": { "shape_name": "ReservedInstancesListing", "type": "structure", "members": { "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": null, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "InstanceCounts": { "shape_name": "InstanceCountList", "type": "list", "members": { "shape_name": "InstanceCount", "type": "structure", "members": { "State": { "shape_name": "ListingState", "type": "string", "enum": [ "available", "sold", "cancelled", "pending" ], "documentation": null, "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "instanceCount" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": null, "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": null, "xmlname": "currencyCode" }, "Active": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "active" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "clientToken" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "reservedInstancesListingsSet" } }, "documentation": null }, "errors": [], "documentation": null }, "CancelSpotInstanceRequests": { "name": "CancelSpotInstanceRequests", "input": { "shape_name": "CancelSpotInstanceRequestsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SpotInstanceRequestIds": { "shape_name": "SpotInstanceRequestIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SpotInstanceRequestId" }, "documentation": "\n

\n Specifies the ID of the Spot Instance request.\n

\n ", "required": true, "flattened": true } }, "documentation": null }, "output": { "shape_name": "CancelSpotInstanceRequestsResult", "type": "structure", "members": { "CancelledSpotInstanceRequests": { "shape_name": "CancelledSpotInstanceRequestList", "type": "list", "members": { "shape_name": "CancelledSpotInstanceRequest", "type": "structure", "members": { "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotInstanceRequestId" }, "State": { "shape_name": "CancelSpotInstanceRequestState", "type": "string", "enum": [ "active", "open", "closed", "cancelled", "completed" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "spotInstanceRequestSet" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Cancels one or more Spot Instance requests.\n

\n

\n Spot Instances are instances that Amazon EC2 starts\n on your behalf when the maximum price that you specify\n exceeds the current Spot Price. Amazon EC2 periodically\n sets the Spot Price based on available Spot Instance\n capacity and current spot instance requests.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n " }, "ConfirmProductInstance": { "name": "ConfirmProductInstance", "input": { "shape_name": "ConfirmProductInstanceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ProductCode": { "shape_name": "String", "type": "string", "documentation": "\n

\n The product code to confirm.\n

\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance to confirm.\n

\n ", "required": true } }, "documentation": "\n

\n A request to verify whether an Amazon DevPay product code is associated\n with an instance.\n

\n

\n This can only be executed by the owner of the AMI and is useful when an\n AMI owner wants to verify whether a user's instance is eligible for support.\n

\n " }, "output": { "shape_name": "ConfirmProductInstanceResult", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The instance owner's account ID. Only present if the product code is\n attached to the instance.\n

\n ", "xmlname": "ownerId" } }, "documentation": "\n

\n The result of calling the ConfirmProductInstance operation.\n

\n " }, "errors": [], "documentation": "\n

\n The ConfirmProductInstance operation returns true if the specified product code\n is attached to the specified instance. The operation returns false if the\n product code is not attached to the instance.\n

\n

\n The ConfirmProductInstance operation can only be executed by the owner of the\n AMI. This feature is useful when an AMI owner is providing support and wants to\n verify whether a user's instance is eligible.\n

\n " }, "CopyImage": { "name": "CopyImage", "input": { "shape_name": "CopyImageRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "SourceImageId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": null, "required": false }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": { "shape_name": "CopyImageResult", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "imageId" } }, "documentation": null }, "errors": [], "documentation": null }, "CopySnapshot": { "name": "CopySnapshot", "input": { "shape_name": "CopySnapshotRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "SourceSnapshotId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": { "shape_name": "CopySnapshotResult", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "snapshotId" } }, "documentation": null }, "errors": [], "documentation": null }, "CreateCustomerGateway": { "name": "CreateCustomerGateway", "input": { "shape_name": "CreateCustomerGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n The type of VPN connection this customer gateway supports.\n

\n ", "required": true }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tThe Internet-routable IP address for the customer gateway's outside interface.\n\t\tThe address must be static\n

\n ", "required": true, "xmlname": "IpAddress" }, "BgpAsn": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateCustomerGatewayResult", "type": "structure", "members": { "CustomerGateway": { "shape_name": "CustomerGateway", "type": "structure", "members": { "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the customer gateway.\n

\n ", "xmlname": "customerGatewayId" }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n Describes the current state of the customer gateway.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the type of VPN connection the\n customer gateway supports.\n

\n ", "xmlname": "type" }, "IpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the Internet-routable IP address of the\n customer gateway's outside interface.\n

\n ", "xmlname": "ipAddress" }, "BgpAsn": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).\n

\n ", "xmlname": "bgpAsn" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the CustomerGateway.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n Information about the customer gateway.\n

\n ", "xmlname": "customerGateway" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Provides information to AWS about your customer gateway device. The customer gateway is the\n appliance at your end of the VPN connection (compared to the VPN gateway, which is the device\n at the AWS side of the VPN connection). You can have a single active customer gateway per AWS\n account (active means that you've created a VPN connection to use with the customer gateway). AWS\n might delete any customer gateway that you create with this operation if you leave it inactive for an\n extended period of time.\n

\n

\n You must provide the Internet-routable IP address of the customer gateway's external interface. The IP\n address must be static.\n

\n

\n You must also provide the device's Border Gateway Protocol (BGP) Autonomous System Number\n (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already,\n you can use a private ASN (in the 64512 - 65534 range). For more information about ASNs, go to\n \n http://en.wikipedia.org/wiki/Autonomous_system_%28Internet%29.\n

\n " }, "CreateDhcpOptions": { "name": "CreateDhcpOptions", "input": { "shape_name": "CreateDhcpOptionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "DhcpConfigurations": { "shape_name": "DhcpConfigurationList", "type": "list", "members": { "shape_name": "DhcpConfiguration", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of a DHCP option.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains a set of values for a DHCP option.\n

\n ", "flattened": true } }, "documentation": "\n

\n The DhcpConfiguration data type\n

\n ", "xmlname": "DhcpConfiguration" }, "documentation": "\n

\n A set of one or more DHCP configurations.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateDhcpOptionsResult", "type": "structure", "members": { "DhcpOptions": { "shape_name": "DhcpOptions", "type": "structure", "members": { "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the set of DHCP options.\n

\n ", "xmlname": "dhcpOptionsId" }, "DhcpConfigurations": { "shape_name": "DhcpConfigurationList", "type": "list", "members": { "shape_name": "DhcpConfiguration", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of a DHCP option.\n

\n ", "xmlname": "key" }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "item" }, "documentation": "\n

\n Contains a set of values for a DHCP option.\n

\n ", "xmlname": "valueSet" } }, "documentation": "\n

\n The DhcpConfiguration data type\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains information about the set of DHCP options.\n

\n ", "xmlname": "dhcpConfigurationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the DhcpOptions.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n A set of one or more DHCP options.\n

\n ", "xmlname": "dhcpOptions" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Creates a set of DHCP options that you can then associate with one or more VPCs, causing all existing\n and new instances that you launch in those VPCs to use the set of DHCP options. The following table\n lists the individual DHCP options you can specify. For more information about the options, go to\n http://www.ietf.org/rfc/rfc2132.txt\n

\n " }, "CreateImage": { "name": "CreateImage", "input": { "shape_name": "CreateImageRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance from which to create the new image.\n

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the new AMI being created.\n

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the new AMI being created.\n

\n " }, "NoReboot": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n By default this property is set to false, which means Amazon EC2\n attempts to cleanly shut down the instance before image creation and reboots\n the instance afterwards. When set to true, Amazon EC2 will not shut down the\n instance before creating the image. When this option is used, file system\n integrity on the created image cannot be guaranteed.\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingRequestList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n " }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "BlockDeviceMapping" }, "documentation": null, "flattened": true } }, "documentation": "\n

\n Represents a request to create a new EC2 image.\n

\n " }, "output": { "shape_name": "CreateImageResult", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the new AMI.\n

\n ", "xmlname": "imageId" } }, "documentation": "\n

\n The result of creating a new EC2 image. Contains the ID of the new image.\n

\n " }, "errors": [], "documentation": "\n

\n Creates an Amazon EBS-backed AMI from a \"running\" or \"stopped\" instance.\n AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores.\n They can be up to 1 TiB in size, use storage that persists on instance failure, and can be stopped and started.\n

\n " }, "CreateInstanceExportTask": { "name": "CreateInstanceExportTask", "input": { "shape_name": "CreateInstanceExportTaskRequest", "type": "structure", "members": { "Description": { "shape_name": "String", "type": "string", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": null }, "ExportToS3Task": { "shape_name": "ExportToS3TaskSpecification", "type": "structure", "members": { "DiskImageFormat": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null }, "ContainerFormat": { "shape_name": "ContainerFormat", "type": "string", "enum": [ "ova" ], "documentation": null }, "S3Bucket": { "shape_name": "String", "type": "string", "documentation": null }, "S3Prefix": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null, "xmlname": "ExportToS3" } }, "documentation": null }, "output": { "shape_name": "CreateInstanceExportTaskResult", "type": "structure", "members": { "ExportTask": { "shape_name": "ExportTask", "type": "structure", "members": { "ExportTaskId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "exportTaskId" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "State": { "shape_name": "ExportTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": null, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "InstanceExportDetails": { "shape_name": "InstanceExportDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": null, "xmlname": "targetEnvironment" } }, "documentation": null, "xmlname": "instanceExport" }, "ExportToS3Task": { "shape_name": "ExportToS3Task", "type": "structure", "members": { "DiskImageFormat": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "xmlname": "diskImageFormat" }, "ContainerFormat": { "shape_name": "ContainerFormat", "type": "string", "enum": [ "ova" ], "documentation": null, "xmlname": "containerFormat" }, "S3Bucket": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "s3Bucket" }, "S3Key": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "s3Key" } }, "documentation": null, "xmlname": "exportToS3" } }, "documentation": null, "xmlname": "exportTask" } }, "documentation": null }, "errors": [], "documentation": null }, "CreateInternetGateway": { "name": "CreateInternetGateway", "input": { "shape_name": "CreateInternetGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": { "shape_name": "CreateInternetGatewayResult", "type": "structure", "members": { "InternetGateway": { "shape_name": "InternetGateway", "type": "structure", "members": { "InternetGatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "internetGatewayId" }, "Attachments": { "shape_name": "InternetGatewayAttachmentList", "type": "list", "members": { "shape_name": "InternetGatewayAttachment", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "internetGateway" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Creates a new Internet gateway in your AWS account. After creating the Internet gateway,\n\t\tyou then attach it to a VPC using AttachInternetGateway. For more information\n\t\tabout your VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.\n

\n " }, "CreateKeyPair": { "name": "CreateKeyPair", "input": { "shape_name": "CreateKeyPairRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique name for the new key pair.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a request to create a new EC2 key pair.\n

\n " }, "output": { "shape_name": "CreateKeyPairResult", "type": "structure", "members": { "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\n

\n The SHA-1 digest of the DER encoded private key.\n

\n ", "xmlname": "keyFingerprint" }, "KeyMaterial": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unencrypted PEM encoded RSA private key.\n

\n ", "xmlname": "keyMaterial" } }, "documentation": "\n

\n The result of creating a new EC2 key pair.\n

\n " }, "errors": [], "documentation": "\n

\n The CreateKeyPair operation creates a new 2048 bit RSA key pair and returns a\n unique ID that can be used to reference this key pair when launching new\n instances. For more information, see RunInstances.\n

\n " }, "CreateNetworkAcl": { "name": "CreateNetworkAcl", "input": { "shape_name": "CreateNetworkAclRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC where the network ACL will be created.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "CreateNetworkAclResult", "type": "structure", "members": { "NetworkAcl": { "shape_name": "NetworkAcl", "type": "structure", "members": { "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "default" }, "Entries": { "shape_name": "NetworkAclEntryList", "type": "list", "members": { "shape_name": "NetworkAclEntry", "type": "structure", "members": { "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "ruleNumber" }, "Protocol": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "protocol" }, "RuleAction": { "shape_name": "RuleAction", "type": "string", "enum": [ "allow", "deny" ], "documentation": null, "xmlname": "ruleAction" }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "egress" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "cidrBlock" }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.\n

\n ", "xmlname": "type" }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.\n

\n ", "xmlname": "code" } }, "documentation": null, "xmlname": "icmpTypeCode" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe first port in the range. Required if specifying tcp or udp for the protocol.\n

\n ", "xmlname": "from" }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe last port in the range. Required if specifying tcp or udp for the protocol.\n

\n ", "xmlname": "to" } }, "documentation": null, "xmlname": "portRange" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "entrySet" }, "Associations": { "shape_name": "NetworkAclAssociationList", "type": "list", "members": { "shape_name": "NetworkAclAssociation", "type": "structure", "members": { "NetworkAclAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclAssociationId" }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "networkAcl" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Creates a new network ACL in a VPC. Network ACLs provide an optional layer of security\n\t\t(on top of security groups) for the instances in your VPC. For more information about\n\t\tnetwork ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.\n

\n " }, "CreateNetworkAclEntry": { "name": "CreateNetworkAclEntry", "input": { "shape_name": "CreateNetworkAclEntryRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the ACL where the entry will be created.\n

\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Rule number to assign to the entry (e.g., 100). ACL entries are processed in ascending\n\t\torder by rule number.\n

\n ", "required": true }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n IP protocol the rule applies to. Valid Values: tcp, udp,\n\t\ticmp or an IP protocol number.\n

\n ", "required": true }, "RuleAction": { "shape_name": "RuleAction", "type": "string", "enum": [ "allow", "deny" ], "documentation": "\n

\n Whether to allow or deny traffic that matches the rule.\n

\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n \tWhether this rule applies to egress traffic from the subnet (true) or ingress traffic to the subnet (false).\n

\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n The CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).\n

\n ", "required": true }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.\n

\n " }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.\n

\n " } }, "documentation": "\n \t

ICMP values.

\n ", "xmlname": "Icmp" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe first port in the range. Required if specifying tcp or udp for the protocol.\n

\n " }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe last port in the range. Required if specifying tcp or udp for the protocol.\n

\n " } }, "documentation": "\n\t\t

Port ranges.

\n " } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n \tCreates an entry (i.e., rule) in a network ACL with a rule number you specify. Each network\n\t\tACL has a set of numbered ingress rules and a separate set of numbered egress rules. When\n\t\tdetermining whether a packet should be allowed in or out of a subnet associated with the ACL,\n\t\tAmazon VPC processes the entries in the ACL according to the rule numbers, in ascending order.\n \t

\n

\n\t\tImportant: We recommend that you leave room between the rules (e.g., 100, 110, 120,\n\t\tetc.), and not number them sequentially (101, 102, 103, etc.). This allows you to easily\n\t\tadd a new rule between existing ones without having to renumber the rules.\n \t

\n

\n\t\tAfter you add an entry, you can't modify it; you must either replace it, or create a new\n\t\tentry and delete the old one.\n \t

\n

\n\t\tFor more information about network ACLs, go to Network ACLs in the Amazon Virtual Private\n\t\tCloud User Guide.\n

\n " }, "CreateNetworkInterface": { "name": "CreateNetworkInterface", "input": { "shape_name": "CreateNetworkInterfaceRequest", "type": "structure", "members": { "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "flattened": true }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressSpecificationList", "type": "list", "members": { "shape_name": "PrivateIpAddressSpecification", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "documentation": null, "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null }, "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": { "shape_name": "CreateNetworkInterfaceResult", "type": "structure", "members": { "NetworkInterface": { "shape_name": "NetworkInterface", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "requesterId" }, "RequesterManaged": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "requesterManaged" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": null, "xmlname": "status" }, "MacAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "macAddress" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" } }, "documentation": null, "xmlname": "attachment" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null, "xmlname": "association" }, "TagSet": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "PrivateIpAddresses": { "shape_name": "NetworkInterfacePrivateIpAddressList", "type": "list", "members": { "shape_name": "NetworkInterfacePrivateIpAddress", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null, "xmlname": "association" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" } }, "documentation": "\n

\n Specifies the characteristics of a network interface.\n

\n ", "xmlname": "networkInterface" } }, "documentation": null }, "errors": [], "documentation": null }, "CreatePlacementGroup": { "name": "CreatePlacementGroup", "input": { "shape_name": "CreatePlacementGroupRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup.\n

\n ", "required": true }, "Strategy": { "shape_name": "PlacementStrategy", "type": "string", "enum": [ "cluster" ], "documentation": "\n

\n The PlacementGroup strategy.\n

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Creates a PlacementGroup into which multiple Amazon EC2\n instances can be launched.\n Users must give the group a name unique within the scope of the user account.\n

\n " }, "CreateReservedInstancesListing": { "name": "CreateReservedInstancesListing", "input": { "shape_name": "CreateReservedInstancesListingRequest", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "required": true }, "PriceSchedules": { "shape_name": "PriceScheduleSpecificationList", "type": "list", "members": { "shape_name": "PriceScheduleSpecification", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": null }, "Price": { "shape_name": "Double", "type": "double", "documentation": null }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": null } }, "documentation": null }, "documentation": null, "required": true, "flattened": true }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CreateReservedInstancesListingResult", "type": "structure", "members": { "ReservedInstancesListings": { "shape_name": "ReservedInstancesListingList", "type": "list", "members": { "shape_name": "ReservedInstancesListing", "type": "structure", "members": { "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": null, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "InstanceCounts": { "shape_name": "InstanceCountList", "type": "list", "members": { "shape_name": "InstanceCount", "type": "structure", "members": { "State": { "shape_name": "ListingState", "type": "string", "enum": [ "available", "sold", "cancelled", "pending" ], "documentation": null, "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "instanceCount" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": null, "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": null, "xmlname": "currencyCode" }, "Active": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "active" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "clientToken" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "reservedInstancesListingsSet" } }, "documentation": null }, "errors": [], "documentation": null }, "CreateRoute": { "name": "CreateRoute", "input": { "shape_name": "CreateRouteRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the route table where the route will be added.\n

\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n The CIDR address block used for the destination match. For example:\n\t\t0.0.0.0/0. Routing decisions are based on the most specific match.\n

\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n \tThe ID of a VPN or Internet gateway attached to your VPC. You must provide either GatewayId or\n\t\tInstanceId, but not both.\n

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n \tThe ID of a NAT instance in your VPC. You must provide either GatewayId or\n\t\tInstanceId, but not both.\n

\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n \tCreates a new route in a route table within a VPC. The route's target can be either\n\t\ta gateway attached to the VPC or a NAT instance in the VPC.\n \t

\n

\n\t\tWhen determining how to route traffic, we use the route with the most specific match.\n\t\tFor example, let's say the traffic is destined for 192.0.2.3, and the\n\t\troute table includes the following two routes:\n \t

\n\t\t\n

\n\t\tBoth routes apply to the traffic destined for 192.0.2.3. However, the\n\t\tsecond route in the list is more specific, so we use that route to determine where\n\t\tto target the traffic.\n \t

\n

\n\t\tFor more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n

\n " }, "CreateRouteTable": { "name": "CreateRouteTable", "input": { "shape_name": "CreateRouteTableRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC where the route table will be created.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "CreateRouteTableResult", "type": "structure", "members": { "RouteTable": { "shape_name": "RouteTable", "type": "structure", "members": { "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "Routes": { "shape_name": "RouteList", "type": "list", "members": { "shape_name": "Route", "type": "structure", "members": { "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "destinationCidrBlock" }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "gatewayId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceOwnerId" }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "State": { "shape_name": "RouteState", "type": "string", "enum": [ "active", "blackhole" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "routeSet" }, "Associations": { "shape_name": "RouteTableAssociationList", "type": "list", "members": { "shape_name": "RouteTableAssociation", "type": "structure", "members": { "RouteTableAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableAssociationId" }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "Main": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "main" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "PropagatingVgws": { "shape_name": "PropagatingVgwList", "type": "list", "members": { "shape_name": "PropagatingVgw", "type": "structure", "members": { "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "gatewayId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "propagatingVgwSet" } }, "documentation": null, "xmlname": "routeTable" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Creates a new route table within a VPC. After you create a new route table, you can add\n\t\troutes and associate the table with a subnet. For more information about route tables,\n\t\tgo to Route Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n

\n " }, "CreateSecurityGroup": { "name": "CreateSecurityGroup", "input": { "shape_name": "CreateSecurityGroupRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group.\n

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Description of the group. This is informational only.\n

\n ", "required": true, "xmlname": "GroupDescription" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the VPC.\n

\n " } }, "documentation": "\n

\n Represents a request to create a new EC2 security group.\n

\n " }, "output": { "shape_name": "CreateSecurityGroupResult", "type": "structure", "members": { "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": null }, "errors": [], "documentation": "\n

\n The CreateSecurityGroup operation creates a new security group.\n

\n

\n Every instance is launched in a security group. If no security group is\n specified during launch, the instances are launched in the default security\n group. Instances within the same security group have unrestricted network\n access to each other. Instances will reject network access attempts from other\n instances in a different security group. As the owner of instances you can\n grant or revoke specific permissions using the AuthorizeSecurityGroupIngress\n and RevokeSecurityGroupIngress operations.\n

\n " }, "CreateSnapshot": { "name": "CreateSnapshot", "input": { "shape_name": "CreateSnapshotRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the volume from which to create the snapshot.\n

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the new snapshot.\n

\n " } }, "documentation": "\n

\n Represents a request to create a snapshot from an Elastic Block Storage (EBS)\n volume.\n

\n " }, "output": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this snapshot.\n

\n ", "xmlname": "snapshotId" }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the volume from which this snapshot was created.\n

\n ", "xmlname": "volumeId" }, "State": { "shape_name": "SnapshotState", "type": "string", "enum": [ "pending", "completed", "error" ], "documentation": "\n

\n Snapshot state (e.g., pending, completed, or error).\n

\n ", "xmlname": "status" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Time stamp when the snapshot was initiated.\n

\n ", "xmlname": "startTime" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\n

\n The progress of the snapshot, in percentage.\n

\n ", "xmlname": "progress" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n AWS Access Key ID of the user who owns the snapshot.\n

\n ", "xmlname": "ownerId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Description of the snapshot.\n

\n\n ", "xmlname": "description" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "OwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS account alias (e.g., \"amazon\", \"redhat\", \"self\", etc.) or AWS\n account ID that owns the AMI.\n

\n ", "xmlname": "ownerAlias" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Snapshot.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n The new snapshot.\n

\n ", "xmlname": "snapshot" }, "errors": [], "documentation": "\n

\n Create a snapshot of the volume identified by volume ID. A volume does not have to be detached\n at the time the snapshot is taken.\n

\n \n Snapshot creation requires that the system is in a consistent state.\n For instance, this means that if taking a snapshot of a database, the tables must\n be read-only locked to ensure that the snapshot will not contain a corrupted\n version of the database. Therefore, be careful when using this API to ensure that\n the system remains in the consistent state until the create snapshot status\n has returned.\n \n " }, "CreateSpotDatafeedSubscription": { "name": "CreateSpotDatafeedSubscription", "input": { "shape_name": "CreateSpotDatafeedSubscriptionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon S3 bucket in which to store the Spot Instance datafeed.\n

\n ", "required": true }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix that is prepended to datafeed files.\n

\n " } }, "documentation": null }, "output": { "shape_name": "CreateSpotDatafeedSubscriptionResult", "type": "structure", "members": { "SpotDatafeedSubscription": { "shape_name": "SpotDatafeedSubscription", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS account ID of the account.\n

\n ", "xmlname": "ownerId" }, "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon S3 bucket where the Spot Instance data feed is located.\n

\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the prefix that is prepended to data feed files.\n

\n ", "xmlname": "prefix" }, "State": { "shape_name": "DatafeedSubscriptionState", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n

\n Specifies the state of the Spot Instance request.\n

\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": "\n

\n Specifies a fault code for the Spot Instance request, if present.\n

\n ", "xmlname": "fault" } }, "documentation": "\n

\n The SpotDatafeedSubscriptionType data type.\n

\n ", "xmlname": "spotDatafeedSubscription" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Creates the data feed for Spot Instances,\n enabling you to view Spot Instance usage logs.\n You can create one data feed per account.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n " }, "CreateSubnet": { "name": "CreateSubnet", "input": { "shape_name": "CreateSubnetRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC to create the subnet in.\n

\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n The CIDR block the subnet is to cover.\n

\n ", "required": true }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone to create the subnet in.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateSubnetResult", "type": "structure", "members": { "Subnet": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the subnet.\n

\n ", "xmlname": "subnetId" }, "State": { "shape_name": "SubnetState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n

\n Describes the current state of the subnet.\n The state of the subnet may be either\n pending or\n available.\n

\n ", "xmlname": "state" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the ID of the VPC the subnet is in.\n

\n ", "xmlname": "vpcId" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the CIDR block assigned to the subnet.\n

\n ", "xmlname": "cidrBlock" }, "AvailableIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of unused IP addresses in the subnet.\n

\n \n

\n The IP addresses for any stopped instances are\n considered unavailable.\n

\n \n ", "xmlname": "availableIpAddressCount" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Availability Zone the subnet is in.\n

\n ", "xmlname": "availabilityZone" }, "DefaultForAz": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "defaultForAz" }, "MapPublicIpOnLaunch": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "mapPublicIpOnLaunch" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Subnet.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n\n

\n ", "xmlname": "subnet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Creates a subnet in an existing VPC. You can create up to 20 subnets in a VPC. If you add more than\n one subnet to a VPC, they're set up in a star topology with a logical router in the middle.\n When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet.\n Once you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same\n as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the\n VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not\n overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the\n largest uses a /18 netmask (16,384 IP addresses).\n

\n \n

\n AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're\n not available for use.\n

\n \n " }, "CreateTags": { "name": "CreateTags", "input": { "shape_name": "CreateTagsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Resources": { "shape_name": "ResourceIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ResourceId" }, "documentation": "\n

\n One or more IDs of resources to tag. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.\n

\n ", "required": true, "flattened": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n " } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "Tag" }, "documentation": "\n

\n The tags to add or overwrite for the specified resources. Each tag item consists of a key-value pair.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Adds or overwrites tags for the specified resources. Each resource can have a maximum of 10 tags.\n Each tag consists of a key-value pair. Tag keys must be unique per resource.\n

\n " }, "CreateVolume": { "name": "CreateVolume", "input": { "shape_name": "CreateVolumeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Size": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes. Required if you are not creating a\n volume from a snapshot.\n

\n " }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which to create the new volume.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which to create the new volume.\n

\n ", "required": true }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n A request to create a new Amazon EC2 Elastic Block Storage (EBS)\n volume.\n

\n " }, "output": { "shape_name": "Volume", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this volume.\n

\n ", "xmlname": "volumeId" }, "Size": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of this volume, in gigabytes.\n

\n ", "xmlname": "size" }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Optional snapshot from which this volume was created.\n

\n\n ", "xmlname": "snapshotId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Availability zone in which this volume was created.\n

\n ", "xmlname": "availabilityZone" }, "State": { "shape_name": "VolumeState", "type": "string", "enum": [ "creating", "available", "in-use", "deleting", "deleted", "error" ], "documentation": "\n

\n State of this volume (e.g., creating, available).\n

\n ", "xmlname": "status" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when volume creation was initiated.\n

\n ", "xmlname": "createTime" }, "Attachments": { "shape_name": "VolumeAttachmentList", "type": "list", "members": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n How the device is exposed to the instance (e.g., /dev/sdh).\n

\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when this attachment initiated.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n `

\n Whether this volume will be deleted or not when the associated instance is\n terminated.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n Specifies the details of a how an EC2 EBS volume is attached to an instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Information on what this volume is attached to.\n

\n ", "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Volume.\n

\n ", "xmlname": "tagSet" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n The newly created EBS volume.\n

\n ", "xmlname": "volume" }, "errors": [], "documentation": "\n

\n Initializes an empty volume of a given size.\n

\n " }, "CreateVpc": { "name": "CreateVpc", "input": { "shape_name": "CreateVpcRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n A valid CIDR block.\n

\n ", "required": true }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means instances must be launched with tenancy as dedicated.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateVpcResult", "type": "structure", "members": { "Vpc": { "shape_name": "Vpc", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPC.\n

\n ", "xmlname": "vpcId" }, "State": { "shape_name": "VpcState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n

\n Describes the current state of the VPC.\n The state of the subnet may be either\n pending or\n available.\n

\n ", "xmlname": "state" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the CIDR block the VPC covers.\n

\n ", "xmlname": "cidrBlock" }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the set of DHCP options\n associated with the VPC.\n Contains a value of default\n if the default options are associated with\n the VPC.\n

\n ", "xmlname": "dhcpOptionsId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VPC.\n

\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC.\n

\n ", "xmlname": "instanceTenancy" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n\n

\n ", "xmlname": "isDefault" } }, "documentation": "\n

\n Information about the VPC.\n

\n ", "xmlname": "vpc" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Creates a VPC with the CIDR block you specify. The smallest VPC you can create uses a /28 netmask\n (16 IP addresses), and the largest uses a /18 netmask (16,384 IP addresses). To help you decide\n how big to make your VPC, go to the topic about creating VPCs in the Amazon Virtual Private Cloud\n Developer Guide.\n

\n

\n By default, each instance you launch in the VPC has the default DHCP options (the standard EC2 host\n name, no domain name, no DNS server, no NTP server, and no NetBIOS server or node type).\n

\n " }, "CreateVpnConnection": { "name": "CreateVpnConnection", "input": { "shape_name": "CreateVpnConnectionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of VPN connection.\n

\n ", "required": true }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the customer gateway.\n

\n ", "required": true }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPN gateway.\n

\n ", "required": true }, "Options": { "shape_name": "VpnConnectionOptionsSpecification", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateVpnConnectionResult", "type": "structure", "members": { "VpnConnection": { "shape_name": "VpnConnection", "type": "structure", "members": { "VpnConnectionId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPN gateway\n at the VPC end of the VPN connection.\n

\n ", "xmlname": "vpnConnectionId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n

\n Describes the current state of the VPN connection.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "CustomerGatewayConfiguration": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains configuration information in the native XML format\n for the VPN connection's customer gateway.\n

\n

\n This element is\n always present in the CreateVpnConnection response;\n however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the\n pending\n or\n available\n state.\n

\n ", "xmlname": "customerGatewayConfiguration" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n Specifies the type of VPN connection.\n

\n ", "xmlname": "type" }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies ID of the customer gateway at the end\n of the VPN connection.\n

\n ", "xmlname": "customerGatewayId" }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specfies the ID of the VPN gateway at the\n VPC end of the VPN connection.\n

\n ", "xmlname": "vpnGatewayId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VpnConnection.\n

\n ", "xmlname": "tagSet" }, "VgwTelemetry": { "shape_name": "VgwTelemetryList", "type": "list", "members": { "shape_name": "VgwTelemetry", "type": "structure", "members": { "OutsideIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "outsideIpAddress" }, "Status": { "shape_name": "TelemetryStatus", "type": "string", "enum": [ "UP", "DOWN" ], "documentation": null, "xmlname": "status" }, "LastStatusChange": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "lastStatusChange" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "AcceptedRouteCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "acceptedRouteCount" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "vgwTelemetry" }, "Options": { "shape_name": "VpnConnectionOptions", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "staticRoutesOnly" } }, "documentation": null, "xmlname": "options" }, "Routes": { "shape_name": "VpnStaticRouteList", "type": "list", "members": { "shape_name": "VpnStaticRoute", "type": "structure", "members": { "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "destinationCidrBlock" }, "Source": { "shape_name": "VpnStaticRouteSource", "type": "string", "enum": [ "Static" ], "documentation": null, "xmlname": "source" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "routes" } }, "documentation": "\n

\n\n

\n ", "xmlname": "vpnConnection" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Creates a new VPN connection between an existing VPN gateway and customer gateway. The only\n supported connection type is ipsec.1.\n

\n

\n The response includes information that you need to configure your customer gateway, in XML format.\n We recommend you use the command line version of this operation (ec2-create-vpn-connection),\n which takes an -f option (for format) and returns configuration information formatted as expected by\n the vendor you specified, or in a generic, human readable format. For information about the command,\n go to ec2-create-vpn-connection in the Amazon Virtual Private Cloud Command Line Reference.\n

\n \n

\n We strongly recommend you use HTTPS when calling this operation because the response\n contains sensitive cryptographic information for configuring your customer gateway.\n

\n

\n If you decide to shut down your VPN connection for any reason and then create a new one, you must\n re-configure your customer gateway with the new information returned from this call.\n

\n \n " }, "CreateVpnConnectionRoute": { "name": "CreateVpnConnectionRoute", "input": { "shape_name": "CreateVpnConnectionRouteRequest", "type": "structure", "members": { "VpnConnectionId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "CreateVpnGateway": { "name": "CreateVpnGateway", "input": { "shape_name": "CreateVpnGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n The type of VPN connection this VPN gateway supports.\n

\n ", "required": true }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which to create the VPN gateway.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "CreateVpnGatewayResult", "type": "structure", "members": { "VpnGateway": { "shape_name": "VpnGateway", "type": "structure", "members": { "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPN gateway.\n

\n ", "xmlname": "vpnGatewayId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n

\n Describes the current state of the VPN gateway.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n Specifies the type of VPN connection the VPN gateway supports.\n

\n ", "xmlname": "type" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Availability Zone where the VPN gateway was created.\n

\n ", "xmlname": "availabilityZone" }, "VpcAttachments": { "shape_name": "VpcAttachmentList", "type": "list", "members": { "shape_name": "VpcAttachment", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains information about the VPCs attached to the VPN gateway.\n

\n ", "xmlname": "attachments" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VpnGateway.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n\n

\n ", "xmlname": "vpnGateway" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Creates a new VPN gateway. A VPN gateway is the VPC-side endpoint for your VPN connection. You\n can create a VPN gateway before creating the VPC itself.\n

\n " }, "DeactivateLicense": { "name": "DeactivateLicense", "input": { "shape_name": "DeactivateLicenseRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "LicenseId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID for the specific license to deactivate against.\n

\n ", "required": true }, "Capacity": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the amount of capacity to deactivate against the license.\n

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deactivates a specific number of licenses.\n Deactivations can be done against a specific license ID\n after they have persisted for at least a 90-day period.\n

\n " }, "DeleteCustomerGateway": { "name": "DeleteCustomerGateway", "input": { "shape_name": "DeleteCustomerGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the customer gateway to delete.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a customer gateway. You must delete the VPN connection before deleting the customer\n gateway.\n

\n

\n You can have a single active customer gateway per AWS account (active means that you've created\n a VPN connection with that customer gateway). AWS might delete any customer gateway you leave\n inactive for an extended period of time.\n

\n " }, "DeleteDhcpOptions": { "name": "DeleteDhcpOptions", "input": { "shape_name": "DeleteDhcpOptionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the DHCP options set to delete.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a set of DHCP options that you specify. Amazon VPC returns an error if the set of options\n you specify is currently associated with a VPC. You can disassociate the set of options by associating\n either a new set of options or the default options with the VPC.\n

\n " }, "DeleteInternetGateway": { "name": "DeleteInternetGateway", "input": { "shape_name": "DeleteInternetGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InternetGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Internet gateway to be deleted.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Deletes an Internet gateway from your AWS account. The gateway must not be attached to a VPC.\n\t\tFor more information about your VPC and Internet gateway, go to Amazon Virtual Private Cloud\n\t\tUser Guide.\n

\n " }, "DeleteKeyPair": { "name": "DeleteKeyPair", "input": { "shape_name": "DeleteKeyPairRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Amazon EC2 key pair to delete.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a request to delete an Amazon EC2 key pair.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The DeleteKeyPair operation deletes a key pair.\n

\n " }, "DeleteNetworkAcl": { "name": "DeleteNetworkAcl", "input": { "shape_name": "DeleteNetworkAclRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the network ACL to be deleted.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Deletes a network ACL from a VPC. The ACL must not have any subnets associated with it. You can't\n\t\tdelete the default network ACL. For more information about network ACLs, go to Network ACLs in the\n\t\tAmazon Virtual Private Cloud User Guide.\n

\n " }, "DeleteNetworkAclEntry": { "name": "DeleteNetworkAclEntry", "input": { "shape_name": "DeleteNetworkAclEntryRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the network ACL.\n

\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Rule number for the entry to delete.\n

\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Whether the rule to delete is an egress rule (true) or ingress rule (false).\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Deletes an ingress or egress entry (i.e., rule) from a network ACL. For more information about\n\t\tnetwork ACLs, go to Network ACLs in the Amazon Virtual Private Cloud User Guide.\n

\n " }, "DeleteNetworkInterface": { "name": "DeleteNetworkInterface", "input": { "shape_name": "DeleteNetworkInterfaceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "DeletePlacementGroup": { "name": "DeletePlacementGroup", "input": { "shape_name": "DeletePlacementGroupRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup to delete.\n

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a PlacementGroup from a user's account.\n Terminate all Amazon EC2 instances in the placement group before deletion.\n

\n " }, "DeleteRoute": { "name": "DeleteRoute", "input": { "shape_name": "DeleteRouteRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the route table where the route will be deleted.\n

\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n The CIDR range for the route you want to delete. The value you specify must exactly\n\t\tmatch the CIDR for the route you want to delete.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Deletes a route from a route table in a VPC. For more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n

\n " }, "DeleteRouteTable": { "name": "DeleteRouteTable", "input": { "shape_name": "DeleteRouteTableRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tThe ID of the route table to be deleted.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n\t\tDeletes a route table from a VPC. The route table must not be associated with a subnet. You can't\n\t\tdelete the main route table. For more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n

\n " }, "DeleteSecurityGroup": { "name": "DeleteSecurityGroup", "input": { "shape_name": "DeleteSecurityGroupRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Amazon EC2 security group to delete.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Amazon EC2 security group to delete.\n

\n " } }, "documentation": "\n

\n Represents a request to delete an Amazon EC2 security group.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The DeleteSecurityGroup operation deletes a security group.\n

\n\n \n

\n If you attempt to delete a security group that contains instances, a fault is\n returned.\n

\n

\n If you attempt to delete a security group that is referenced by another\n security group, a fault is returned. For example, if security group B has a\n rule that allows access from security group A, security group A cannot be\n deleted until the allow rule is removed.\n

\n \n " }, "DeleteSnapshot": { "name": "DeleteSnapshot", "input": { "shape_name": "DeleteSnapshotRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot to delete.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a request to delete an EBS snapshot.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes the snapshot identified by snapshotId.\n

\n " }, "DeleteSpotDatafeedSubscription": { "name": "DeleteSpotDatafeedSubscription", "input": { "shape_name": "DeleteSpotDatafeedSubscriptionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": "\n

\n Deletes the data feed for Spot Instances.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes the data feed for Spot Instances.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n " }, "DeleteSubnet": { "name": "DeleteSubnet", "input": { "shape_name": "DeleteSubnetRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tThe ID of the subnet you want to delete.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a subnet from a VPC. You must terminate all running instances in the subnet before deleting it,\n otherwise Amazon VPC returns an error.\n

\n " }, "DeleteTags": { "name": "DeleteTags", "input": { "shape_name": "DeleteTagsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Resources": { "shape_name": "ResourceIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ResourceId" }, "documentation": "\n

\n A list of one or more resource IDs. This could be the ID of an AMI, an instance, an EBS volume, or snapshot, etc.\n

\n ", "required": true, "flattened": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n " } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "Tag" }, "documentation": "\n

\n The tags to delete from the specified resources. Each tag item consists of a key-value pair.\n

\n

\n If a tag is specified without a value, the tag and all of its values are deleted.\n

\n ", "flattened": true } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes tags from the specified Amazon EC2 resources.\n

\n " }, "DeleteVolume": { "name": "DeleteVolume", "input": { "shape_name": "DeleteVolumeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS volume to delete.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a request to delete an Elastic Block Storage (EBS) volume.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a previously created volume. Once successfully deleted,\n a new volume can be created with the same name.\n

\n " }, "DeleteVpc": { "name": "DeleteVpc", "input": { "shape_name": "DeleteVpcRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tThe ID of the VPC you want to delete.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a VPC. You must detach or delete all gateways or other objects that are dependent on the\n\t\tVPC first. For example, you must terminate all running instances, delete all VPC security groups\n\t\t(except the default), delete all the route tables (except the default), etc.\n

\n " }, "DeleteVpnConnection": { "name": "DeleteVpnConnection", "input": { "shape_name": "DeleteVpnConnectionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnConnectionId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPN connection to delete\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a VPN connection. Use this if you want to delete a VPC and all its associated components.\n Another reason to use this operation is if you believe the tunnel credentials for your VPN connection\n have been compromised. In that situation, you can delete the VPN connection and create a new one\n that has new keys, without needing to delete the VPC or VPN gateway. If you create a new VPN\n connection, you must reconfigure the customer gateway using the new configuration information\n returned with the new VPN connection ID.\n

\n

\n If you're deleting the VPC and all its associated parts, we recommend you detach the VPN gateway\n from the VPC and delete the VPC before deleting the VPN connection.\n

\n " }, "DeleteVpnConnectionRoute": { "name": "DeleteVpnConnectionRoute", "input": { "shape_name": "DeleteVpnConnectionRouteRequest", "type": "structure", "members": { "VpnConnectionId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "DeleteVpnGateway": { "name": "DeleteVpnGateway", "input": { "shape_name": "DeleteVpnGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPN gateway to delete.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes a VPN gateway. Use this when you want to delete a VPC and all its associated components\n because you no longer need them. We recommend that before you delete a VPN gateway, you detach\n it from the VPC and delete the VPN connection. Note that you don't need to delete the VPN gateway if\n you just want to delete and re-create the VPN connection between your VPC and data center.\n

\n " }, "DeregisterImage": { "name": "DeregisterImage", "input": { "shape_name": "DeregisterImageRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the AMI to deregister.\n

\n ", "required": true } }, "documentation": "\n

\n A request to deregister an Amazon Machine Image (AMI).\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The DeregisterImage operation deregisters an AMI. Once deregistered, instances\n of the AMI can no longer be launched.\n

\n " }, "DescribeAccountAttributes": { "name": "DescribeAccountAttributes", "input": { "shape_name": "DescribeAccountAttributesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AttributeNames": { "shape_name": "AccountAttributeNameStringList", "type": "list", "members": { "shape_name": "AccountAttributeName", "type": "string", "enum": [ "supported-platforms", "default-vpc" ], "documentation": null, "xmlname": "AttributeName" }, "documentation": null, "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeAccountAttributesResult", "type": "structure", "members": { "AccountAttributes": { "shape_name": "AccountAttributeList", "type": "list", "members": { "shape_name": "AccountAttribute", "type": "structure", "members": { "AttributeName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attributeName" }, "AttributeValues": { "shape_name": "AccountAttributeValueList", "type": "list", "members": { "shape_name": "AccountAttributeValue", "type": "structure", "members": { "AttributeValue": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attributeValue" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "attributeValueSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "accountAttributeSet" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeAddresses": { "name": "DescribeAddresses", "input": { "shape_name": "DescribeAddressesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "PublicIps": { "shape_name": "PublicIpStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "PublicIp" }, "documentation": "\n

\n The optional list of Elastic IP addresses to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Addresses.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "AllocationIds": { "shape_name": "AllocationIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "AllocationId" }, "documentation": null, "flattened": true } }, "documentation": "\n

\n A request to describe a user's available Elastic IPs.\n

\n " }, "output": { "shape_name": "DescribeAddressesResult", "type": "structure", "members": { "Addresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "instanceId" }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "publicIp" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" }, "Domain": { "shape_name": "DomainType", "type": "string", "enum": [ "vpc", "standard" ], "documentation": null, "xmlname": "domain" }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "NetworkInterfaceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceOwnerId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of Elastic IPs.\n

\n ", "xmlname": "addressesSet" } }, "documentation": "\n

\n The result of describing an account's available Elastic IPs.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeAddresses operation lists elastic IP addresses assigned to your\n account.\n

\n ", "filters": { "allocation-id": { "documentation": "The allocation ID for the address (VPC only)." }, "association-id": { "documentation": "The association ID for the address (VPC only)." }, "domain": { "choices": [ "standard", "vpc" ], "documentation": "Indicates whether the address is for use in a VPC." }, "instance-id": { "documentation": "The instance the address is associated with (if any)." }, "network-interface-id": { "documentation": "The network interface (if any) that the address is associated with (VPC only)." }, "private-ip-address": { "documentation": "The private IP address associated with the Elastic IP address (VPC only)." }, "public-ip": { "documentation": "The Elastic IP address." } } }, "DescribeAvailabilityZones": { "name": "DescribeAvailabilityZones", "input": { "shape_name": "DescribeAvailabilityZonesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ZoneNames": { "shape_name": "ZoneNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ZoneName" }, "documentation": "\n

\n A list of the availability zone names to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for AvailabilityZones.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the Amazon EC2 availability zones in the current\n region.\n

\n " }, "output": { "shape_name": "DescribeAvailabilityZonesResult", "type": "structure", "members": { "AvailabilityZones": { "shape_name": "AvailabilityZoneList", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "ZoneName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the Availability Zone.\n

\n ", "xmlname": "zoneName" }, "State": { "shape_name": "AvailabilityZoneState", "type": "string", "enum": [ "available" ], "documentation": "\n

\n State of the Availability Zone.\n

\n ", "xmlname": "zoneState" }, "RegionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the region in which this zone resides.\n

\n ", "xmlname": "regionName" }, "Messages": { "shape_name": "AvailabilityZoneMessageList", "type": "list", "members": { "shape_name": "AvailabilityZoneMessage", "type": "structure", "members": { "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": null, "xmlname": "item" }, "documentation": "\n

\n A list of messages about the Availability Zone.\n

\n ", "xmlname": "messageSet" } }, "documentation": "\n

\n An EC2 availability zone, separate and fault tolerant from other\n availability zones.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described Amazon EC2 availability zones.\n

\n ", "xmlname": "availabilityZoneInfo" } }, "documentation": "\n

\n The result of describing the Amazon EC2 availability zones in the current\n region.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeAvailabilityZones operation describes availability zones that are\n currently available to the account and their states.\n

\n

\n Availability zones are not the same across accounts. The availability zone\n us-east-1a for account A is not necessarily the same as us-east-1a for account\n B. Zone assignments are mapped independently for each account.\n

\n ", "filters": { "message": { "documentation": "Information about the Availability Zone." }, "region-name": { "documentation": "The region for the Availability Zone (for example, us-east-1)." }, "state": { "choices": [ "available" ], "documentation": "The state of the Availability Zone" }, "zone-name": { "documentation": "The name of the zone." } } }, "DescribeBundleTasks": { "name": "DescribeBundleTasks", "input": { "shape_name": "DescribeBundleTasksRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "BundleIds": { "shape_name": "BundleIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "BundleId" }, "documentation": "\n

\n The list of bundle task IDs to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for BundleTasks.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the bundle tasks for the user's account.\n

\n " }, "output": { "shape_name": "DescribeBundleTasksResult", "type": "structure", "members": { "BundleTasks": { "shape_name": "BundleTaskList", "type": "list", "members": { "shape_name": "BundleTask", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Instance associated with this bundle task.\n

\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique identifier for this task.\n

\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": "\n

\n The state of this task.\n

\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time this task started.\n

\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time of the most recent update for the task.\n

\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n The bucket in which to store the AMI. You can specify a bucket that you\n already own or a new bucket that Amazon EC2 creates on your\n behalf.\n

\n

\n If you specify a bucket that belongs to someone else, Amazon EC2 returns\n an error.\n

\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix to use when storing the AMI in S3.\n

\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Access Key ID of the owner of the Amazon S3 bucket.\n

\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\n

\n A Base64-encoded Amazon S3 upload policy that gives Amazon EC2\n permission to upload items into Amazon S3 on the user's behalf.\n

\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\n

\n The signature of the Base64 encoded JSON document.\n

\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\n

\n The details of S3 storage for bundling a Windows instance.\n

\n " } }, "documentation": "\n

\n Amazon S3 storage locations.\n

\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\n

\n The level of task completion, in percent (e.g., 20%).\n

\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error code.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Error message.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n If the task fails, a description of the error.\n

\n ", "xmlname": "error" } }, "documentation": "\n

\n Represents a task to bundle an EC2 Windows instance into a new image.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described bundle tasks.\n

\n ", "xmlname": "bundleInstanceTasksSet" } }, "documentation": "\n

\n The result of describing the bundle tasks for the user's account.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeBundleTasks operation describes in-progress\n and recent bundle tasks. Complete and failed tasks are\n removed from the list a short time after completion.\n If no bundle ids are given, all bundle tasks are returned.\n

\n ", "filters": { "bundle-id": { "documentation": "The ID of the bundle task." }, "error-code": { "documentation": "If the task failed, the error code returned." }, "error-message": { "documentation": "If the task failed, the error message returned." }, "instance-id": { "documentation": "The ID of the instance that was bundled." }, "progress": { "documentation": "The level of task completion, as a percentage (for example, 20%)." }, "s3-bucket": { "documentation": "The Amazon S3 bucket to store the AMI." }, "s3-prefix": { "documentation": "The beginning of the AMI name." }, "start-time": { "documentation": "The time the task started (for example, 2008-09-15T17:15:20.000Z)." }, "state": { "choices": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": "The state of the task." }, "update-time": { "documentation": "The time of the most recent update for the task (for example, 2008-09-15T17:15:20.000Z)." } } }, "DescribeConversionTasks": { "name": "DescribeConversionTasks", "input": { "shape_name": "DescribeConversionTasksRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": null, "flattened": true }, "ConversionTaskIds": { "shape_name": "ConversionIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ConversionTaskId" }, "documentation": null, "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeConversionTasksResult", "type": "structure", "members": { "ConversionTasks": { "shape_name": "DescribeConversionTaskList", "type": "list", "members": { "shape_name": "ConversionTask", "type": "structure", "members": { "ConversionTaskId": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "expirationTime" }, "ImportInstance": { "shape_name": "ImportInstanceTaskDetails", "type": "structure", "members": { "Volumes": { "shape_name": "ImportInstanceVolumeDetailSet", "type": "list", "members": { "shape_name": "ImportInstanceVolumeDetailItem", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "required": true, "xmlname": "volumes" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": null, "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" } }, "documentation": null, "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": null, "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "conversionTasks" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeCustomerGateways": { "name": "DescribeCustomerGateways", "input": { "shape_name": "DescribeCustomerGatewaysRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "CustomerGatewayIds": { "shape_name": "CustomerGatewayIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CustomerGatewayId" }, "documentation": "\n

\n A set of one or more customer gateway IDs.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Customer Gateways.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DescribeCustomerGatewaysResult", "type": "structure", "members": { "CustomerGateways": { "shape_name": "CustomerGatewayList", "type": "list", "members": { "shape_name": "CustomerGateway", "type": "structure", "members": { "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the customer gateway.\n

\n ", "xmlname": "customerGatewayId" }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n Describes the current state of the customer gateway.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the type of VPN connection the\n customer gateway supports.\n

\n ", "xmlname": "type" }, "IpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the Internet-routable IP address of the\n customer gateway's outside interface.\n

\n ", "xmlname": "ipAddress" }, "BgpAsn": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the customer gateway's Border Gateway Protocol (BGP)\n Autonomous System Number (ASN).\n

\n ", "xmlname": "bgpAsn" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the CustomerGateway.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n The CustomerGateway data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n\n

\n ", "xmlname": "customerGatewaySet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Gives you information about your customer gateways. You can filter the results to return information\n only about customer gateways that match criteria you specify. For example, you could ask to get\n information about a particular customer gateway (or all) only if the gateway's state is pending or\n available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for\n the Internet-routable external interface, and the gateway's state is pending or available). The result\n includes information for a particular customer gateway only if the gateway matches all your filters. If\n there's no match, no special message is returned; the response is simply empty. The following table\n shows the available filters.\n

\n ", "filters": { "bgp-asn": { "documentation": "The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN)." }, "customer-gateway-id": { "documentation": "The ID of the customer gateway." }, "ip-address": { "documentation": "The IP address of the customer gateway's Internet-routable external interface (for example, 12.1.2.3)." }, "state": { "choices": [ "pending", "available", "deleting", "deleted" ], "documentation": "The state of the customer gateway." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "type": { "choices": [ "ipsec.1" ], "documentation": "The type of customer gateway. Currently the only supported type is ipsec.1 ." } } }, "DescribeDhcpOptions": { "name": "DescribeDhcpOptions", "input": { "shape_name": "DescribeDhcpOptionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "DhcpOptionsIds": { "shape_name": "DhcpOptionsIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "DhcpOptionsId" }, "documentation": null, "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for DhcpOptions.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeDhcpOptionsResult", "type": "structure", "members": { "DhcpOptions": { "shape_name": "DhcpOptionsList", "type": "list", "members": { "shape_name": "DhcpOptions", "type": "structure", "members": { "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the set of DHCP options.\n

\n ", "xmlname": "dhcpOptionsId" }, "DhcpConfigurations": { "shape_name": "DhcpConfigurationList", "type": "list", "members": { "shape_name": "DhcpConfiguration", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of a DHCP option.\n

\n ", "xmlname": "key" }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "item" }, "documentation": "\n

\n Contains a set of values for a DHCP option.\n

\n ", "xmlname": "valueSet" } }, "documentation": "\n

\n The DhcpConfiguration data type\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains information about the set of DHCP options.\n

\n ", "xmlname": "dhcpConfigurationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the DhcpOptions.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n The DhcpOptions data type.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "dhcpOptionsSet" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Gives you information about one or more sets of DHCP options. You can specify one or more DHCP\n options set IDs, or no IDs (to describe all your sets of DHCP options). The returned information\n consists of:\n

\n \n ", "filters": { "dhcp-options-id": { "documentation": "The ID of a set of DHCP options." }, "key": { "documentation": "The key for one of the options (for example, domain-name )." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "value": { "documentation": "The value for one of the options." } } }, "DescribeExportTasks": { "name": "DescribeExportTasks", "input": { "shape_name": "DescribeExportTasksRequest", "type": "structure", "members": { "ExportTaskIds": { "shape_name": "ExportTaskIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ExportTaskId" }, "documentation": null, "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeExportTasksResult", "type": "structure", "members": { "ExportTasks": { "shape_name": "ExportTaskList", "type": "list", "members": { "shape_name": "ExportTask", "type": "structure", "members": { "ExportTaskId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "exportTaskId" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "State": { "shape_name": "ExportTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": null, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "InstanceExportDetails": { "shape_name": "InstanceExportDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": null, "xmlname": "targetEnvironment" } }, "documentation": null, "xmlname": "instanceExport" }, "ExportToS3Task": { "shape_name": "ExportToS3Task", "type": "structure", "members": { "DiskImageFormat": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "xmlname": "diskImageFormat" }, "ContainerFormat": { "shape_name": "ContainerFormat", "type": "string", "enum": [ "ova" ], "documentation": null, "xmlname": "containerFormat" }, "S3Bucket": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "s3Bucket" }, "S3Key": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "s3Key" } }, "documentation": null, "xmlname": "exportToS3" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "exportTaskSet" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeImageAttribute": { "name": "DescribeImageAttribute", "input": { "shape_name": "DescribeImageAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the AMI whose attribute is to be described.\n

\n ", "required": true }, "Attribute": { "shape_name": "ImageAttributeName", "type": "string", "enum": [ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping" ], "documentation": "\n

\n The name of the attribute to describe.\n

\n

\n Available attribute names: productCodes, kernel,\n ramdisk, launchPermisson, blockDeviceMapping\n

\n ", "required": true } }, "documentation": "\n

\n A request to describe an Amazon Machine Image (AMI) attribute. Only\n one attribute may be described per request.\n

\n " }, "output": { "shape_name": "ImageAttribute", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the associated AMI.\n

\n ", "xmlname": "imageId" }, "LaunchPermissions": { "shape_name": "LaunchPermissionList", "type": "list", "members": { "shape_name": "LaunchPermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of the user involved in this launch permission.\n

\n ", "xmlname": "userId" }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The AWS group of the user involved in this launch permission.\n

\n

\n Available groups: all\n

\n ", "xmlname": "group" } }, "documentation": "\n

\n Describes a permission to launch an Amazon Machine Image (AMI).\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Launch permissions for the associated AMI.\n

\n ", "xmlname": "launchPermission" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Product codes for the associated AMI.\n

\n ", "xmlname": "productCodes" }, "KernelId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n Kernel ID of the associated AMI.\n

\n ", "xmlname": "kernel" }, "RamdiskId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n Ramdisk ID of the associated AMI.\n

\n ", "xmlname": "ramdisk" }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n User-created description of the associated AMI.\n

\n ", "xmlname": "description" }, "SriovNetSupport": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "String value", "xmlname": "sriovNetSupport" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n ", "xmlname": "noDevice" } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Block device mappings for the associated AMI.\n

\n ", "xmlname": "blockDeviceMapping" } }, "documentation": "\n

\n The described image attribute of the associated AMI.\n

\n ", "xmlname": "imageAttribute" }, "errors": [], "documentation": "\n

\n The DescribeImageAttribute operation returns information about an attribute of\n an AMI. Only one attribute can be specified per call.\n

\n " }, "DescribeImages": { "name": "DescribeImages", "input": { "shape_name": "DescribeImagesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageIds": { "shape_name": "ImageIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ImageId" }, "documentation": "\n

\n An optional list of the AMI IDs to describe. If not specified, all AMIs\n will be described.\n

\n ", "flattened": true }, "Owners": { "shape_name": "OwnerStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Owner" }, "documentation": "\n

\n An optional list of owners by which to scope the described AMIs.\n Valid values are:\n

\n\n \n

\n The values self, aws-marketplace, amazon, and all are literals.\n

\n ", "flattened": true }, "ExecutableUsers": { "shape_name": "ExecutableByStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ExecutableBy" }, "documentation": "\n

\n An optional list of users whose launch permissions will be used to\n scope the described AMIs. Valid values are:\n

\n \n

\n The values self and all are literals.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Images.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the available Amazon Machine Images (AMIs).\n

\n " }, "output": { "shape_name": "DescribeImagesResult", "type": "structure", "members": { "Images": { "shape_name": "ImageList", "type": "list", "members": { "shape_name": "Image", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the AMI.\n

\n ", "xmlname": "imageId" }, "ImageLocation": { "shape_name": "String", "type": "string", "documentation": "\n

\n The location of the AMI.\n

\n ", "xmlname": "imageLocation" }, "State": { "shape_name": "ImageState", "type": "string", "enum": [ "available", "deregistered" ], "documentation": "\n

\n Current state of the AMI. If the operation returns available, the image is\n successfully registered and available for launching.\n If the operation returns deregistered, the image is deregistered and no\n longer available for launching.\n

\n ", "xmlname": "imageState" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n AWS Access Key ID of the image owner.\n

\n ", "xmlname": "imageOwnerId" }, "Public": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True if this image has public launch permissions. False if it only has\n implicit and explicit launch permissions.\n

\n ", "xmlname": "isPublic" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Product codes of the AMI.\n

\n ", "xmlname": "productCodes" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\n

\n The architecture of the image.\n

\n ", "xmlname": "architecture" }, "ImageType": { "shape_name": "ImageTypeValues", "type": "string", "enum": [ "machine", "kernel", "ramdisk" ], "documentation": "\n

\n The type of image (machine, kernel, or ramdisk).\n

\n ", "xmlname": "imageType" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The kernel associated with the image, if any. Only applicable for machine\n images.\n

\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The RAM disk associated with the image, if any. Only applicable for\n machine images.\n

\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\n

\n The operating platform of the AMI.\n

\n ", "xmlname": "platform" }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "sriovNetSupport" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Reason code for the state change.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Descriptive message for the state change.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n The reason for the state change.\n

\n ", "xmlname": "stateReason" }, "ImageOwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS account alias (e.g., \"amazon\", \"redhat\", \"self\", etc.) or AWS\n account ID that owns the AMI.\n

\n ", "xmlname": "imageOwnerAlias" }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the AMI that was provided during image creation.\n

\n ", "xmlname": "name" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the AMI that was provided during image creation.\n

\n ", "xmlname": "description" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

\n The root device type used by the AMI. The AMI can use an Amazon EBS or\n instance store root device.\n

\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The root device name (e.g., /dev/sda1).\n

\n ", "xmlname": "rootDeviceName" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n ", "xmlname": "noDevice" } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n

\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": null, "xmlname": "virtualizationType" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Image.\n

\n ", "xmlname": "tagSet" }, "Hypervisor": { "shape_name": "HypervisorType", "type": "string", "enum": [ "ovm", "xen" ], "documentation": null, "xmlname": "hypervisor" } }, "documentation": "\n

\n Represents an Amazon Machine Image (AMI) that can be run on an Amazon EC2\n instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of the described AMIs.\n

\n ", "xmlname": "imagesSet" } }, "documentation": "\n

\n The result of describing Amazon Machine Images (AMIs).\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeImages operation returns information about AMIs, AKIs, and ARIs\n available to the user. Information returned includes image type, product codes,\n architecture, and kernel and RAM disk IDs. Images available to the user include\n public images available for any user to launch, private images owned by the\n user making the request, and private images owned by other users for which the\n user has explicit launch permissions.\n

\n

\n Launch permissions fall into three categories:\n

\n \n

\n The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or\n users with launch permissions. If no options are specified, Amazon EC2 returns\n all AMIs for which the user has launch permissions.\n

\n

\n If you specify one or more AMI IDs, only AMIs that have the specified IDs are\n returned. If you specify an invalid AMI ID, a fault is returned. If you specify\n an AMI ID for which you do not have access, it will not be included in the\n returned results.\n

\n

\n If you specify one or more AMI owners, only AMIs from the specified owners and\n for which you have access are returned. The results can include the account IDs\n of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that\n you own.\n

\n

\n If you specify a list of executable users, only users that have launch\n permissions for the AMIs are returned. You can specify account IDs (if you own\n the AMI(s)), self for AMIs for which you own or have explicit permissions, or\n all for public AMIs.\n

\n \n Deregistered images are included in the returned results for an unspecified\n interval after deregistration.\n \n ", "filters": { "architecture": { "choices": [ "i386", "x86_64" ], "documentation": "The image architecture." }, "block-device-mapping.delete-on-termination": { "documentation": "Whether the Amazon EBS volume is deleted on instance termination." }, "block-device-mapping.device-name": { "documentation": "The device name (for example, /dev/sdh) for the Amazon EBS volume." }, "block-device-mapping.snapshot-id": { "documentation": "The ID of the snapshot used for the Amazon EBS volume." }, "block-device-mapping.volume-size": { "documentation": "The volume size of the Amazon EBS volume, in GiB." }, "block-device-mapping.volume-type": { "choices": [ "standard", "io1" ], "documentation": "The volume type of the Amazon EBS volume." }, "description": { "documentation": "The description of the image (provided during image creation)." }, "hypervisor": { "choices": [ "ovm", "xen" ], "documentation": "The hypervisor type." }, "image-id": { "documentation": "The ID of the image." }, "image-type": { "choices": [ "machine", "kernel", "ramdisk" ], "documentation": "The image type." }, "is-public": { "documentation": "Whether the image is public." }, "kernel-id": { "documentation": "The kernel ID." }, "manifest-location": { "documentation": "The location of the image manifest." }, "name": { "documentation": "The name of the AMI (provided during image creation)." }, "owner-alias": { "documentation": "The AWS account alias (for example, amazon )." }, "owner-id": { "documentation": "The AWS account ID of the image owner." }, "platform": { "documentation": "The platform. To only list Windows-based AMIs, use windows . Otherwise, leave blank." }, "product-code": { "documentation": "The product code." }, "product-code.type": { "choices": [ "devpay", "marketplace" ], "documentation": "The type of the product code." }, "ramdisk-id": { "documentation": "The RAM disk ID." }, "root-device-name": { "documentation": "The name of the root device volume (for example, /dev/sda1)." }, "root-device-type": { "choices": [ "ebs", "instance-store" ], "documentation": "The type of the root device volume." }, "state": { "choices": [ "available", "pending", "failed" ], "documentation": "The state of the image." }, "state-reason-code": { "documentation": "The reason code for the state change." }, "state-reason-message": { "documentation": "The message for the state change." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "virtualization-type": { "choices": [ "paravirtual", "hvm" ], "documentation": "The virtualization type." } } }, "DescribeInstanceAttribute": { "name": "DescribeInstanceAttribute", "input": { "shape_name": "DescribeInstanceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose instance attribute is being described.\n

\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\n

\n The name of the attribute to describe.\n

\n

\n\t\tAvailable attribute names: instanceType, kernel, ramdisk,\n\t\tuserData, disableApiTermination, instanceInitiatedShutdownBehavior,\n\t\trootDeviceName, blockDeviceMapping\n

\n ", "required": true } }, "documentation": "\n

\n A request to describe an attribute of one of a user's EC2 instances.\n Only one attribute can be specified per call.\n

\n " }, "output": { "shape_name": "InstanceAttribute", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the associated instance.\n

\n ", "xmlname": "instanceId" }, "InstanceType": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n The instance type (e.g., m1.small, c1.medium, m2.2xlarge, and so on).\n

\n ", "xmlname": "instanceType" }, "KernelId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n The kernel ID of the associated instance.\n

\n ", "xmlname": "kernel" }, "RamdiskId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n The ramdisk ID of the associated instance.\n

\n ", "xmlname": "ramdisk" }, "UserData": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n MIME, Base64-encoded user data.\n

\n ", "xmlname": "userData" }, "DisableApiTermination": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "\n

\n Whether this instance can be terminated. You must modify this attribute\n before you can terminate any \"locked\" instances.\n

\n ", "xmlname": "disableApiTermination" }, "InstanceInitiatedShutdownBehavior": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n Whether this instance's Amazon EBS volumes are deleted when the instance is\n shut down.\n

\n ", "xmlname": "instanceInitiatedShutdownBehavior" }, "RootDeviceName": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "\n

\n The root device name (e.g., /dev/sda1).\n

\n ", "xmlname": "rootDeviceName" }, "BlockDeviceMappings": { "shape_name": "InstanceBlockDeviceMappingList", "type": "list", "members": { "shape_name": "InstanceBlockDeviceMapping", "type": "structure", "members": { "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The device name (e.g., /dev/sdh) at which the block device is exposed on\n the instance.\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsInstanceBlockDevice", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS volume.\n

\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n The status of the EBS volume.\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time at which the EBS volume was attached to the associated instance.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n The optional EBS device mapped to the specified device name.\n

\n ", "xmlname": "ebs" } }, "documentation": "\n

\n Describes how block devices are mapped on an Amazon EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n How block devices are exposed to this instance. Each mapping is made up\n of a virtualName and a deviceName.\n

\n ", "xmlname": "blockDeviceMapping" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "productCodes" }, "EbsOptimized": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "Boolean value", "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "String value", "xmlname": "sriovNetSupport" } }, "documentation": "\n

\n The described instance attribute.\n

\n " }, "errors": [], "documentation": "\n

\n Returns information about an attribute of an instance.\n Only one attribute can be specified per call.\n

\n " }, "DescribeInstanceStatus": { "name": "DescribeInstanceStatus", "input": { "shape_name": "DescribeInstanceStatusRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n The list of instance IDs. If not specified, all instances are described.\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n The list of filters to limit returned results.\n ", "flattened": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n A string specifying the next paginated set of results to return.\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\n The maximum number of paginated instance items per response.\n " }, "IncludeAllInstances": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeInstanceStatusResult", "type": "structure", "members": { "InstanceStatuses": { "shape_name": "InstanceStatusList", "type": "list", "members": { "shape_name": "InstanceStatus", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n The ID of the Amazon EC2 instance.\n ", "xmlname": "instanceId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n The Amazon EC2 instance's availability zone.\n ", "xmlname": "availabilityZone" }, "Events": { "shape_name": "InstanceStatusEventList", "type": "list", "members": { "shape_name": "InstanceStatusEvent", "type": "structure", "members": { "Code": { "shape_name": "EventCode", "type": "string", "enum": [ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ], "documentation": "\n The associated code of the event.\n Valid values: instance-reboot, system-reboot, instance-retirement\n ", "xmlname": "code" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n A description of the event.\n ", "xmlname": "description" }, "NotBefore": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n The earliest scheduled start time for the event.\n ", "xmlname": "notBefore" }, "NotAfter": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n The latest scheduled end time for the event.\n ", "xmlname": "notAfter" } }, "documentation": "\n Represents an event that affects the status of an Amazon EC2 instance.\n ", "xmlname": "item" }, "documentation": "\n Events that affect the status of the associated Amazon EC2 instance.\n ", "xmlname": "eventsSet" }, "InstanceState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n Represents the state of an Amazon EC2 instance.\n

\n ", "xmlname": "instanceState" }, "SystemStatus": { "shape_name": "InstanceStatusSummary", "type": "structure", "members": { "Status": { "shape_name": "SummaryStatus", "type": "string", "enum": [ "ok", "impaired", "insufficient-data", "not-applicable" ], "documentation": null, "xmlname": "status" }, "Details": { "shape_name": "InstanceStatusDetailsList", "type": "list", "members": { "shape_name": "InstanceStatusDetails", "type": "structure", "members": { "Name": { "shape_name": "StatusName", "type": "string", "enum": [ "reachability" ], "documentation": null, "xmlname": "name" }, "Status": { "shape_name": "StatusType", "type": "string", "enum": [ "passed", "failed", "insufficient-data" ], "documentation": null, "xmlname": "status" }, "ImpairedSince": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "impairedSince" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "details" } }, "documentation": null, "xmlname": "systemStatus" }, "InstanceStatus": { "shape_name": "InstanceStatusSummary", "type": "structure", "members": { "Status": { "shape_name": "SummaryStatus", "type": "string", "enum": [ "ok", "impaired", "insufficient-data", "not-applicable" ], "documentation": null, "xmlname": "status" }, "Details": { "shape_name": "InstanceStatusDetailsList", "type": "list", "members": { "shape_name": "InstanceStatusDetails", "type": "structure", "members": { "Name": { "shape_name": "StatusName", "type": "string", "enum": [ "reachability" ], "documentation": null, "xmlname": "name" }, "Status": { "shape_name": "StatusType", "type": "string", "enum": [ "passed", "failed", "insufficient-data" ], "documentation": null, "xmlname": "status" }, "ImpairedSince": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "impairedSince" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "details" } }, "documentation": null, "xmlname": "instanceStatus" } }, "documentation": "\n Represents the status of an Amazon EC2 instance.\n ", "xmlname": "item" }, "documentation": "\n Collection of instance statuses describing the state of the requested instances.\n ", "xmlname": "instanceStatusSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n A string specifying the next paginated set of results to return.\n ", "xmlname": "nextToken" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance. Instance status provides information about two types of scheduled events for an instance that may require your attention:\n

\n \n

\n\tIf your instance is permanently retired, it will not be restarted. You can avoid retirement by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a healthy host.\n

\n

\n\tDescribeInstanceStatus returns information only for instances in the running state.\n

\n

\n\tYou can filter the results to return information only about instances that match criteria you specify. For example, you could get information about instances in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). An instance must match at least one of the specified values for it to be included in the results.\n

\n

\n\tYou can specify multiple filters. An instance must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.\n

\n

\n\tYou can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \\*amazon\\?\\\\ searches for the literal string *amazon?\\.\n

\n

\n The following filters are available:\n

\n \n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "InstanceStatuses", "py_input_token": "next_token" }, "filters": { "availability-zone": { "documentation": "The Availability Zone of the instance." }, "event.code": { "choices": [ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ], "documentation": "The code identifying the type of event." }, "event.description": { "documentation": "A description of the event." }, "event.not-after": { "documentation": "The latest end time for the scheduled event." }, "event.not-before": { "documentation": "The earliest start time for the scheduled event." }, "instance-state-code": { "choices": [ "0", "16", "32", "48", "64", "80" ], "documentation": "A code representing the state of the instance. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented" }, "instance-state-name": { "choices": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "The state of the instance." }, "instance-status.reachability": { "choices": [ "passed", "failed", "initializing", "insufficient-data" ], "documentation": "Filters on instance status where the name is reachability ." }, "instance-status.status": { "choices": [ "ok", "impaired", "initializing", "insufficient-data", "not-applicable" ], "documentation": "The status of the instance." }, "system-status.reachability": { "choices": [ "passed", "failed", "initializing", "insufficient-data" ], "documentation": "Filters on system status where the name is reachability ." }, "system-status.status": { "choices": [ "ok", "impaired", "initializing", "insufficient-data", "not-applicable" ], "documentation": "The system status of the instance." } } }, "DescribeInstances": { "name": "DescribeInstances", "input": { "shape_name": "DescribeInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n An optional list of the instances to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Instances.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n A request to describe the Amazon EC2 instances in a user's account.\n

\n

\n If you specify one or more instance IDs, Amazon EC2 returns information\n for those instances.\n If you do not specify instance IDs, Amazon EC2 returns information for\n all relevant instances.\n If you specify an invalid instance ID, a fault is returned.\n If you specify an instance that you do not own, it will not be included\n in the returned results.\n

\n

\n Recently terminated instances might appear in the returned results.\n\n The interval within which this could occur is usually less than one hour\n from the time the instance is terminated.\n

\n " }, "output": { "shape_name": "DescribeInstancesResult", "type": "structure", "members": { "Reservations": { "shape_name": "ReservationList", "type": "list", "members": { "shape_name": "Reservation", "type": "structure", "members": { "ReservationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this reservation.\n

\n ", "xmlname": "reservationId" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS Access Key ID of the user who owns the reservation.\n

\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the user who requested the instances in this\n reservation.\n

\n ", "xmlname": "requesterId" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of security groups requested for the instances in this\n reservation.\n

\n ", "xmlname": "groupSet" }, "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique ID of the instance launched.\n

\n ", "xmlname": "instanceId" }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Image ID of the AMI used to launch the instance.\n

\n ", "xmlname": "imageId" }, "State": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "instanceState" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The private DNS name assigned to the instance. This DNS name can only be used inside the\n Amazon EC2 network. This element remains empty until the instance enters a running state.\n

\n ", "xmlname": "privateDnsName" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The public DNS name assigned to the instance. This DNS name is contactable from outside\n the Amazon EC2 network. This element remains empty until the instance enters a running state.\n

\n ", "xmlname": "dnsName" }, "StateTransitionReason": { "shape_name": "String", "type": "string", "documentation": "\n

\n Reason for the most recent state transition. This might be an empty string.\n

\n ", "xmlname": "reason" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If this instance was launched with an associated key pair, this displays the key pair name.\n

\n ", "xmlname": "keyName" }, "AmiLaunchIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The AMI launch index, which can be used to find this instance within the launch group.\n

\n ", "xmlname": "amiLaunchIndex" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Product codes attached to this instance.\n

\n ", "xmlname": "productCodes" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type. For more information on instance types, please see\n the\n \n Amazon Elastic Compute Cloud Developer Guide.\n

\n ", "xmlname": "instanceType" }, "LaunchTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time this instance launched.\n

\n ", "xmlname": "launchTime" }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n ", "xmlname": "groupName" }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.\n

\n ", "xmlname": "tenancy" } }, "documentation": "\n

\n The location where this instance launched.\n

\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Kernel associated with this instance.\n

\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n RAM disk associated with this instance.\n

\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\n

\n Platform of the instance (e.g., Windows).\n

\n ", "xmlname": "platform" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\n

\n The state of monitoring on an Amazon EC2 instance (ex: enabled,\n disabled).\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n Monitoring status for this instance.\n

\n ", "xmlname": "monitoring" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC subnet ID in which the instance is running.\n

\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC in which the instance is running.\n

\n ", "xmlname": "vpcId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the private IP address that is assigned to the instance (Amazon VPC).\n

\n ", "xmlname": "privateIpAddress" }, "PublicIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP address of the instance.\n

\n ", "xmlname": "ipAddress" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Reason code for the state change.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Descriptive message for the state change.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n The reason for the state change.\n

\n ", "xmlname": "stateReason" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\n

\n The architecture of this instance.\n

\n ", "xmlname": "architecture" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

\n The root device type used by the AMI. The AMI can use an Amazon EBS or\n instance store root device.\n

\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The root device name (e.g., /dev/sda1).\n

\n ", "xmlname": "rootDeviceName" }, "BlockDeviceMappings": { "shape_name": "InstanceBlockDeviceMappingList", "type": "list", "members": { "shape_name": "InstanceBlockDeviceMapping", "type": "structure", "members": { "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The device name (e.g., /dev/sdh) at which the block device is exposed on\n the instance.\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsInstanceBlockDevice", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS volume.\n

\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n The status of the EBS volume.\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time at which the EBS volume was attached to the associated instance.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n The optional EBS device mapped to the specified device name.\n

\n ", "xmlname": "ebs" } }, "documentation": "\n

\n Describes how block devices are mapped on an Amazon EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Block device mapping set.\n

\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": null, "xmlname": "virtualizationType" }, "InstanceLifecycle": { "shape_name": "InstanceLifecycleType", "type": "string", "enum": [ "spot" ], "documentation": "\n

\n\n

\n ", "xmlname": "instanceLifecycle" }, "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "spotInstanceRequestId" }, "License": { "shape_name": "InstanceLicense", "type": "structure", "members": { "Pool": { "shape_name": "String", "type": "string", "documentation": "\n

\n The license pool from which this license was used (ex: 'windows').\n

\n ", "xmlname": "pool" } }, "documentation": "\n

\n Represents an active license in use and attached to an Amazon EC2 instance.\n

\n ", "xmlname": "license" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "clientToken" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Instance.\n

\n ", "xmlname": "tagSet" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Hypervisor": { "shape_name": "HypervisorType", "type": "string", "enum": [ "ovm", "xen" ], "documentation": null, "xmlname": "hypervisor" }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceList", "type": "list", "members": { "shape_name": "InstanceNetworkInterface", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ownerId" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": null, "xmlname": "status" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "Attachment": { "shape_name": "InstanceNetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" } }, "documentation": null, "xmlname": "attachment" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" } }, "documentation": null, "xmlname": "association" }, "PrivateIpAddresses": { "shape_name": "InstancePrivateIpAddressList", "type": "list", "members": { "shape_name": "InstancePrivateIpAddress", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" } }, "documentation": null, "xmlname": "association" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfile", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "arn" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "id" } }, "documentation": null, "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "sriovNetSupport" } }, "documentation": "\n

\n Represents an Amazon EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of Amazon EC2 instances included in this reservation.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n An Amazon EC2 reservation of requested EC2 instances.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of reservations containing the describes instances.\n

\n ", "xmlname": "reservationSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "nextToken" } }, "documentation": "\n

\n The result of describing Amazon EC2 instances.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeInstances operation returns information about instances that you\n own.\n

\n

\n If you specify one or more instance IDs, Amazon EC2 returns information for\n those instances. If you do not specify instance IDs, Amazon EC2 returns\n information for all relevant instances. If you specify an invalid instance ID,\n a fault is returned. If you specify an instance that you do not own, it will\n not be included in the returned results.\n

\n

\n Recently terminated instances might appear in the returned results. This\n interval is usually less than one hour.\n

\n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Reservations", "py_input_token": "next_token" }, "filters": { "architecture": { "choices": [ "i386", "x86_64" ], "documentation": "The instance architecture." }, "association.allocation-id": { "documentation": "The allocation ID that AWS returned when you allocated the Elastic IP address for your network interface." }, "association.association-id": { "documentation": "The association ID returned when the network interface was associated with an IP address." }, "association.ip-owner-id": { "documentation": "The owner of the Elastic IP address associated with the network interface." }, "association.public-ip": { "documentation": "The address of the Elastic IP address bound to the network interface." }, "availability-zone": { "documentation": "The Availability Zone of the instance." }, "block-device-mapping.attach-time": { "documentation": "The attach time for an Amazon EBS volume mapped to the instance (for example, 2010-09-15T17:15:20.000Z)" }, "block-device-mapping.delete-on-termination": { "documentation": "Indicates whether the Amazon EBS volume is deleted on instance termination." }, "block-device-mapping.device-name": { "documentation": "The device name (for example, /dev/sdh) for the Amazon EBS volume." }, "block-device-mapping.status": { "choices": [ "attaching", "attached", "detaching", "detached" ], "documentation": "The status for the Amazon EBS volume." }, "block-device-mapping.volume-id": { "documentation": "The volume ID of the Amazon EBS volume." }, "client-token": { "documentation": "The idempotency token you provided when you launched the instance." }, "dns-name": { "documentation": "The public DNS name of the instance." }, "group-id": { "documentation": "The ID of the security group for the instance. If the instance is in a VPC, use instance.group-id instead." }, "group-name": { "documentation": "The name of the security group for the instance. If the instance is in a VPC, use instance.group-name instead." }, "hypervisor": { "choices": [ "ovm", "xen" ], "documentation": "The hypervisor type of the instance." }, "image-id": { "documentation": "The ID of the image used to launch the instance." }, "instance-id": { "documentation": "The ID of the instance." }, "instance-lifecycle": { "choices": [ "spot" ], "documentation": "Indicates whether this is a Spot Instance." }, "instance-state-code": { "choices": [ "0", "16", "32", "48", "64", "80" ], "documentation": "The state of the instance. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented." }, "instance-state-name": { "choices": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "The state of the instance." }, "instance-type": { "documentation": "The type of instance (for example, m1.small )." }, "instance.group-id": { "documentation": "The ID of the security group for the instance. If the instance is in a VPC, use group-id instead." }, "instance.group-name": { "documentation": "The name of the security group for the instance. if the instance is in a VPC, use group-name instead." }, "ip-address": { "documentation": "The public IP address of the instance." }, "kernel-id": { "documentation": "The kernel ID." }, "key-name": { "documentation": "The name of the key pair used when the instance was launched." }, "launch-index": { "documentation": "When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on)." }, "launch-time": { "documentation": "The time the instance was launched (for example, 2010-08-07T11:54:42.000Z)." }, "monitoring-state": { "choices": [ "disabled", "enabled" ], "documentation": "Indicates whether monitoring is enabled for the instance." }, "network-interface-private-dns-name": { "documentation": "The private DNS name of the network interface." }, "network-interface.addresses.association.ip-owner-id": { "documentation": "The owner ID of the private IP address associated with the network interface." }, "network-interface.addresses.association.public-ip": { "documentation": "The ID of the association of an Elastic IP address with a network interface." }, "network-interface.addresses.primary": { "documentation": "Specifies whether the IP address of the network interface is the primary private IP address." }, "network-interface.addresses.private-ip-address": { "documentation": "The private IP address associated with the network interface." }, "network-interface.attachment.attach-time": { "documentation": "The time that the network interface was attached to an instance." }, "network-interface.attachment.attachment-id": { "documentation": "The ID of the interface attachment." }, "network-interface.attachment.delete-on-termination": { "documentation": "Specifies whether the attachment is deleted when an instance is terminated." }, "network-interface.attachment.device-index": { "documentation": "The device index to which the network interface is attached." }, "network-interface.attachment.instance-id": { "documentation": "The ID of the instance to which the network interface is attached." }, "network-interface.attachment.instance-owner-id": { "documentation": "The owner ID of the instance to which the network interface is attached." }, "network-interface.attachment.status": { "documentation": "The status of the attachment." }, "network-interface.availability-zone": { "documentation": "The availability zone for the network interface." }, "network-interface.description": { "documentation": "The description of the network interface." }, "network-interface.group-id": { "documentation": "The ID of a security group associated with the network interface." }, "network-interface.group-name": { "documentation": "The name of a security group associated with the network interface." }, "network-interface.mac-address": { "documentation": "The MAC address of the network interface." }, "network-interface.network-interface.id": { "documentation": "The ID of the network interface." }, "network-interface.owner-id": { "documentation": "The ID of the owner of the network interface." }, "network-interface.requester-id": { "documentation": "The requester ID for the network interface." }, "network-interface.requester-managed": { "documentation": "Indicates whether the network interface is being managed by AWS." }, "network-interface.source-destination-check": { "documentation": "Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC." }, "network-interface.status": { "documentation": "The status of the network interface." }, "network-interface.subnet-id": { "documentation": "The ID of the subnet for the network interface." }, "network-interface.vpc-id": { "documentation": "The ID of the VPC for the network interface." }, "owner-id": { "documentation": "The AWS account ID of the instance owner." }, "placement-group-name": { "documentation": "The name of the placement group for the instance." }, "platform": { "documentation": "The platform. Use windows if you have Windows based instances; otherwise, leave blank." }, "private-dns-name": { "documentation": "The private DNS name of the instance." }, "private-ip-address": { "documentation": "The private IP address of the instance." }, "product-code": { "documentation": "The product code associated with the AMI used to launch the instance." }, "product-code.type": { "choices": [ "devpay", "marketplace" ], "documentation": "The type of product code." }, "ramdisk-id": { "documentation": "The RAM disk ID." }, "reason": { "documentation": "The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter." }, "requester-id": { "documentation": "The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on)" }, "reservation-id": { "documentation": "The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID." }, "root-device-name": { "documentation": "The name of the root device for the instance (for example, /dev/sda1)." }, "root-device-type": { "choices": [ "ebs", "instance-store" ], "documentation": "The type of root device the instance uses." }, "source-dest-check": { "documentation": "Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC." }, "spot-instance-request-id": { "documentation": "The ID of the Spot Instance request." }, "state-reason-code": { "documentation": "The reason code for the state change." }, "state-reason-message": { "documentation": "A message that describes the state change." }, "subnet-id": { "documentation": "The ID of the subnet for the instance." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "virtualization-type": { "choices": [ "paravirtual", "hvm" ], "documentation": "The virtualization type of the instance." }, "vpc-id": { "documentation": "The ID of the VPC the instance is running in." } } }, "DescribeInternetGateways": { "name": "DescribeInternetGateways", "input": { "shape_name": "DescribeInternetGatewaysRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InternetGatewayIds": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InternetGatewayId" }, "documentation": "\n

\n\t\tOne or more Internet gateway IDs.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Internet Gateways.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeInternetGatewaysResult", "type": "structure", "members": { "InternetGateways": { "shape_name": "InternetGatewayList", "type": "list", "members": { "shape_name": "InternetGateway", "type": "structure", "members": { "InternetGatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "internetGatewayId" }, "Attachments": { "shape_name": "InternetGatewayAttachmentList", "type": "list", "members": { "shape_name": "InternetGatewayAttachment", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "internetGatewaySet" } }, "documentation": null }, "errors": [], "documentation": "\n\t\t

\n\t\tGives you information about your Internet gateways. You can filter the results to return information only\n\t\tabout Internet gateways that match criteria you specify. For example, you could get information only about\n\t\tgateways with particular tags. The Internet gateway must match at least one of the specified values for it\n\t\tto be included in the results.\n\t\t

\n\t\t

\n\t\tYou can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged\n\t\twith a particular value). The result includes information for a particular Internet gateway only if the\n\t\tgateway matches all your filters. If there's no match, no special message is returned; the response is\n\t\tsimply empty.\n\t\t

\n\t\t

\n\t\tYou can use wildcards with the filter values: an asterisk matches zero or more characters, and ?\n\t\tmatches exactly one character. You can escape special characters using a backslash before the character.\n\t\tFor example, a value of \\*amazon\\?\\\\ searches for the literal string *amazon?\\.\n\t\t

\n ", "filters": { "attachment.state": { "documentation": "The current state of the attachment between the gateway and the VPC. Returned only if a VPC is attached." }, "attachment.vpc-id": { "documentation": "The ID of an attached VPC." }, "internet-gateway-id": { "documentation": "The ID of the Internet gateway." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." } } }, "DescribeKeyPairs": { "name": "DescribeKeyPairs", "input": { "shape_name": "DescribeKeyPairsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "KeyNames": { "shape_name": "KeyNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "KeyName" }, "documentation": "\n

\n The optional list of key pair names to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for KeyPairs.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n Request to describe information about key pairs available to you.\n

\n

\n If you specify key pairs, information about those key pairs is returned.\n Otherwise, information for all your registered key pairs is\n returned.\n

\n " }, "output": { "shape_name": "DescribeKeyPairsResult", "type": "structure", "members": { "KeyPairs": { "shape_name": "KeyPairList", "type": "list", "members": { "shape_name": "KeyPairInfo", "type": "structure", "members": { "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\n

\n The SHA-1 digest of the DER encoded private key.\n

\n ", "xmlname": "keyFingerprint" } }, "documentation": "\n

\n Describes an Amazon EC2 key pair. This is a summary of the key pair data, and\n will not contain the actual private key material.\n

\n

\n The private key material is only available when initially creating the\n key pair.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described key pairs.\n

\n ", "xmlname": "keySet" } }, "documentation": "\n

\n The result of describing a user's key pairs.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeKeyPairs operation returns information about key pairs available to\n you. If you specify key pairs, information about those key pairs is returned.\n Otherwise, information for all registered key pairs is returned.\n

\n ", "filters": { "fingerprint": { "documentation": "The fingerprint of the key pair." }, "key-name": { "documentation": "The name of the key pair." } } }, "DescribeLicenses": { "name": "DescribeLicenses", "input": { "shape_name": "DescribeLicensesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "LicenseIds": { "shape_name": "LicenseIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "LicenseId" }, "documentation": "\n

\n Specifies the license registration for which details are to be returned.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Licenses.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "DescribeLicensesResult", "type": "structure", "members": { "Licenses": { "shape_name": "LicenseList", "type": "list", "members": { "shape_name": "License", "type": "structure", "members": { "LicenseId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID identifying the license.\n

\n ", "xmlname": "licenseId" }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

\n The license type (ex. \"Microsoft/Windows/Standard\").\n

\n ", "xmlname": "type" }, "Pool": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the pool in which the license is kept.\n

\n ", "xmlname": "pool" }, "Capacities": { "shape_name": "LicenseCapacityList", "type": "list", "members": { "shape_name": "LicenseCapacity", "type": "structure", "members": { "Capacity": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of licenses available.\n

\n ", "xmlname": "capacity" }, "InstanceCapacity": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of Amazon EC2 instances that can be supported with the\n license's capacity.\n

\n ", "xmlname": "instanceCapacity" }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n The state of this license capacity,\n indicating whether the license is actively being used or not.\n

\n ", "xmlname": "state" }, "EarliestAllowedDeactivationTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The earliest allowed time at which a license can be deactivated.\n Some licenses have time restrictions on when they can be activated and reactivated.\n

\n ", "xmlname": "earliestAllowedDeactivationTime" } }, "documentation": "\n

\n Represents the capacity that a license is able to support.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The capacities available for this license,\n indicating how many licenses are in use, how many are available,\n how many Amazon EC2 instances can be supported, etc.\n

\n ", "xmlname": "capacitySet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the License.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n A software license that can be associated with an Amazon EC2\n instance when launched (ex. a Microsoft Windows license).\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Specifies active licenses in use and attached to an Amazon EC2 instance.\n

\n ", "xmlname": "licenseSet" } }, "documentation": "\n

\n " }, "errors": [], "documentation": "\n

\n Provides details of a user's registered licenses.\n Zero or more IDs may be specified on the call.\n When one or more license IDs are specified,\n only data for the specified IDs are returned.\n

\n " }, "DescribeNetworkAcls": { "name": "DescribeNetworkAcls", "input": { "shape_name": "DescribeNetworkAclsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkAclIds": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "NetworkAclId" }, "documentation": "\n\t\t

\n\t\tOne or more network ACL IDs.\n\t\t

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n\t\t

\n\t\tA list of filters used to match properties for Network ACLs.\n\t\tFor a complete reference to the available filter keys for this operation, see the\n\t\tAmazon EC2 API reference.\n\t\t

\n ", "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeNetworkAclsResult", "type": "structure", "members": { "NetworkAcls": { "shape_name": "NetworkAclList", "type": "list", "members": { "shape_name": "NetworkAcl", "type": "structure", "members": { "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "default" }, "Entries": { "shape_name": "NetworkAclEntryList", "type": "list", "members": { "shape_name": "NetworkAclEntry", "type": "structure", "members": { "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "ruleNumber" }, "Protocol": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "protocol" }, "RuleAction": { "shape_name": "RuleAction", "type": "string", "enum": [ "allow", "deny" ], "documentation": null, "xmlname": "ruleAction" }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "egress" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "cidrBlock" }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.\n

\n ", "xmlname": "type" }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.\n

\n ", "xmlname": "code" } }, "documentation": null, "xmlname": "icmpTypeCode" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe first port in the range. Required if specifying tcp or udp for the protocol.\n

\n ", "xmlname": "from" }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe last port in the range. Required if specifying tcp or udp for the protocol.\n

\n ", "xmlname": "to" } }, "documentation": null, "xmlname": "portRange" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "entrySet" }, "Associations": { "shape_name": "NetworkAclAssociationList", "type": "list", "members": { "shape_name": "NetworkAclAssociation", "type": "structure", "members": { "NetworkAclAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclAssociationId" }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkAclId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "networkAclSet" } }, "documentation": null }, "errors": [], "documentation": "\n\t\t

\n\t\tGives you information about the network ACLs in your VPC. You can filter the results to return\n\t\tinformation only about ACLs that match criteria you specify. For example, you could get information\n\t\tonly the ACL associated with a particular subnet. The ACL must match at least one of the specified\n\t\tvalues for it to be included in the results.\n\t\t

\n\t\t

\n\t\tYou can specify multiple filters (e.g., the ACL is associated with a particular subnet and has an\n\t\tegress entry that denies traffic to a particular port). The result includes information for a\n\t\tparticular ACL only if it matches all your filters. If there's no match, no special message is\n\t\treturned; the response is simply empty.\n\t\t

\n\t\t

\n\t\tYou can use wildcards with the filter values: an asterisk matches zero or more characters, and\n\t\t? matches exactly one character. You can escape special characters using a backslash\n\t\tbefore the character. For example, a value of \\*amazon\\?\\\\ searches for the literal\n\t\tstring *amazon?\\.\n\t\t

\n ", "filters": { "association.association-id": { "documentation": "The ID of an association ID for the ACL." }, "association.network-acl-id": { "documentation": "The ID of the network ACL involved in the association." }, "association.subnet-id": { "documentation": "The ID of the subnet involved in the association." }, "default": { "documentation": "Indicates whether the ACL is the default network ACL for the VPC." }, "entry.cidr": { "documentation": "The CIDR range specified in the entry." }, "entry.egress": { "documentation": "Indicates whether the entry applies to egress traffic." }, "entry.icmp.code": { "documentation": "The ICMP code specified in the entry, if any." }, "entry.icmp.type": { "documentation": "The ICMP type specified in the entry, if any." }, "entry.port-range.from": { "documentation": "The start of the port range specified in the entry." }, "entry.port-range.to": { "documentation": "The end of the port range specified in the entry." }, "entry.protocol": { "choices": [ "tcp", "udp", "icmp" ], "documentation": "The protocol specified in the entry." }, "entry.rule-action": { "choices": [ "allow", "deny" ], "documentation": "Indicates whether the entry allows or denies the matching traffic." }, "entry.rule-number": { "documentation": "The number of an entry (i.e., rule) in the ACL's set of entries." }, "network-acl-id": { "documentation": "The ID of the network ACL." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "vpc-id": { "documentation": "The ID of the VPC for the network ACL." } } }, "DescribeNetworkInterfaceAttribute": { "name": "DescribeNetworkInterfaceAttribute", "input": { "shape_name": "DescribeNetworkInterfaceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "SourceDestCheck": { "shape_name": "String", "type": "string", "documentation": null }, "Groups": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupSet" }, "Attachment": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeNetworkInterfaceAttributeResult", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value", "xmlname": "value" } }, "documentation": "String value", "xmlname": "description" }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "Boolean value", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" } }, "documentation": null, "xmlname": "attachment" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeNetworkInterfaces": { "name": "DescribeNetworkInterfaces", "input": { "shape_name": "DescribeNetworkInterfacesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceIds": { "shape_name": "NetworkInterfaceIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "NetworkInterfaceId" }, "documentation": null, "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": null, "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeNetworkInterfacesResult", "type": "structure", "members": { "NetworkInterfaces": { "shape_name": "NetworkInterfaceList", "type": "list", "members": { "shape_name": "NetworkInterface", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "requesterId" }, "RequesterManaged": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "requesterManaged" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": null, "xmlname": "status" }, "MacAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "macAddress" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" } }, "documentation": null, "xmlname": "attachment" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null, "xmlname": "association" }, "TagSet": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "PrivateIpAddresses": { "shape_name": "NetworkInterfacePrivateIpAddressList", "type": "list", "members": { "shape_name": "NetworkInterfacePrivateIpAddress", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "associationId" } }, "documentation": null, "xmlname": "association" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" } }, "documentation": "\n

\n Specifies the characteristics of a network interface.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "networkInterfaceSet" } }, "documentation": null }, "errors": [], "documentation": null, "filters": { "addresses.association.owner-id": { "documentation": "The owner ID of the addresses associated with the network interface." }, "addresses.association.public-ip": { "documentation": "The association ID returned when the network interface was associated with the Elastic IP address." }, "addresses.primary": { "documentation": "Whether the private IP address is the primary IP address associated with the network interface." }, "addresses.private-ip-address": { "documentation": "The private IP addresses associated with the network interface." }, "association.allocation-id": { "documentation": "The allocation ID that AWS returned when you allocated the Elastic IP address for your network interface." }, "association.association-id": { "documentation": "The association ID returned when the network interface was associated with an IP address." }, "association.ip-owner-id": { "documentation": "The owner of the Elastic IP address associated with the network interface." }, "association.public-ip": { "documentation": "The address of the Elastic IP address bound to the network interface." }, "attachment.attach.time": { "documentation": "The time that the network interface was attached to an instance." }, "attachment.attachment-id": { "documentation": "The ID of the interface attachment." }, "attachment.delete-on-termination": { "documentation": "Indicates whether the attachment is deleted when an instance is terminated." }, "attachment.device-index": { "documentation": "The device index to which the network interface is attached." }, "attachment.instance-id": { "documentation": "The ID of the instance to which the network interface is attached." }, "attachment.instance-owner-id": { "documentation": "The owner ID of the instance to which the network interface is attached." }, "attachment.status": { "choices": [ "attaching", "attached", "detaching", "detached" ], "documentation": "The status of the attachment." }, "availability-zone": { "documentation": "The Availability Zone of the network interface." }, "description": { "documentation": "The description of the network interface." }, "group-id": { "documentation": "The ID of a security group associated with the network interface." }, "group-name": { "documentation": "The name of a security group associated with the network interface." }, "mac-address": { "documentation": "The MAC address of the network interface." }, "network-interface-id": { "documentation": "The ID of the network interface." }, "owner-id": { "documentation": "The AWS account ID of the network interface owner." }, "private-dns-name": { "documentation": "The private DNS name of the network interface." }, "private-ip-address": { "documentation": "The private IP address or addresses of the network interface." }, "requester-id": { "documentation": "The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on)." }, "requester-managed": { "documentation": "Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on)." }, "source-dest-check": { "documentation": "Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC." }, "status": { "choices": [ "available", "in-use" ], "documentation": "The status of the network interface. If the network interface is not attached to an instance, the status shows available ; if a network interface is attached to an instance the status shows in-use ." }, "subnet-id": { "documentation": "The ID of the subnet for the network interface." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "vpc-id": { "documentation": "The ID of the VPC for the network interface." } } }, "DescribePlacementGroups": { "name": "DescribePlacementGroups", "input": { "shape_name": "DescribePlacementGroupsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupNames": { "shape_name": "PlacementGroupStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupName" }, "documentation": "\n

\n The name of the PlacementGroup.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Placement Groups.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "DescribePlacementGroupsResult", "type": "structure", "members": { "PlacementGroups": { "shape_name": "PlacementGroupList", "type": "list", "members": { "shape_name": "PlacementGroup", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of this PlacementGroup.\n

\n ", "xmlname": "groupName" }, "Strategy": { "shape_name": "PlacementStrategy", "type": "string", "enum": [ "cluster" ], "documentation": "\n

\n The strategy to use when allocating Amazon EC2 instances for the\n PlacementGroup.\n

\n ", "xmlname": "strategy" }, "State": { "shape_name": "PlacementGroupState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n

\n The state of this PlacementGroup.\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n Represents a placement group into which multiple Amazon EC2\n instances can be launched. A placement group ensures that\n Amazon EC2 instances are physically\n located close enough to support HPC features, such as higher IO network\n connections between instances in the group.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains information about the specified PlacementGroups.\n

\n ", "xmlname": "placementGroupSet" } }, "documentation": "\n

\n " }, "errors": [], "documentation": "\n

\n Returns information about one or more PlacementGroup instances\n in a user's account.\n

\n ", "filters": { "group-name": { "documentation": "The name of the placement group." }, "state": { "choices": [ "pending", "available", "deleting", "deleted" ], "documentation": "The state of the placement group." }, "strategy": { "documentation": "The strategy of the placement group." } } }, "DescribeRegions": { "name": "DescribeRegions", "input": { "shape_name": "DescribeRegionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RegionNames": { "shape_name": "RegionNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "RegionName" }, "documentation": "\n

\n The optional list of regions to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Regions.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n Request to describe the available Amazon EC2 regions.\n

\n " }, "output": { "shape_name": "DescribeRegionsResult", "type": "structure", "members": { "Regions": { "shape_name": "RegionList", "type": "list", "members": { "shape_name": "Region", "type": "structure", "members": { "RegionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the region.\n

\n ", "xmlname": "regionName" }, "Endpoint": { "shape_name": "String", "type": "string", "documentation": "\n

\n Region service endpoint.\n

\n ", "xmlname": "regionEndpoint" } }, "documentation": "\n

\n Represents an Amazon EC2 region. EC2 regions are completely isolated from each\n other.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described Amazon EC2 regions.\n

\n ", "xmlname": "regionInfo" } }, "documentation": "\n

\n The result of describing the available Amazon EC2 regions.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeRegions operation describes regions zones\n that are currently available to the account.\n

\n ", "filters": { "endpoint": { "documentation": "The endpoint of the region (for example, ec2.us-east-1.amazonaws.com)." }, "region-name": { "documentation": "The name of the region." } } }, "DescribeReservedInstances": { "name": "DescribeReservedInstances", "input": { "shape_name": "DescribeReservedInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ReservedInstancesIds": { "shape_name": "ReservedInstancesIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReservedInstancesId" }, "documentation": "\n

\n The optional list of Reserved Instance IDs to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for ReservedInstances.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "OfferingType": { "shape_name": "OfferingTypeValues", "type": "string", "enum": [ "Heavy Utilization", "Medium Utilization", "Light Utilization" ], "documentation": "\n\tThe Reserved Instance offering type.\n " } }, "documentation": "\n

\n A request to describe the purchased Reserved Instances for your\n account.\n

\n " }, "output": { "shape_name": "DescribeReservedInstancesResult", "type": "structure", "members": { "ReservedInstances": { "shape_name": "ReservedInstancesList", "type": "list", "members": { "shape_name": "ReservedInstances", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the Reserved Instances purchase.\n

\n ", "xmlname": "reservedInstancesId" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type on which the Reserved Instances can be used.\n

\n ", "xmlname": "instanceType" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the Reserved Instances can be used.\n

\n ", "xmlname": "availabilityZone" }, "Start": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The date and time the Reserved Instances started.\n

\n ", "xmlname": "start" }, "End": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "end" }, "Duration": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The duration of the Reserved Instances, in seconds.\n

\n ", "xmlname": "duration" }, "UsagePrice": { "shape_name": "Float", "type": "float", "documentation": "\n

\n The usage price of the Reserved Instances, per hour.\n

\n ", "xmlname": "usagePrice" }, "FixedPrice": { "shape_name": "Float", "type": "float", "documentation": "\n

\n The purchase price of the Reserved Instances.\n

\n ", "xmlname": "fixedPrice" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of Reserved Instances purchased.\n

\n\n ", "xmlname": "instanceCount" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\n

\n The Reserved Instances product description (ex: Windows or Unix/Linux).\n

\n ", "xmlname": "productDescription" }, "State": { "shape_name": "ReservedInstanceState", "type": "string", "enum": [ "payment-pending", "active", "payment-failed", "retired" ], "documentation": "\n

\n The state of the Reserved Instances purchase.\n

\n ", "xmlname": "state" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the ReservedInstances.\n

\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The tenancy of the reserved instance (ex: default or dedicated).\n

\n ", "xmlname": "instanceTenancy" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\n

\n The currency of the reserved instance. Specified using ISO 4217 standard (e.g., USD, JPY).\n

\n ", "xmlname": "currencyCode" }, "OfferingType": { "shape_name": "OfferingTypeValues", "type": "string", "enum": [ "Heavy Utilization", "Medium Utilization", "Light Utilization" ], "documentation": "\n\tThe Reserved Instance offering type.\n ", "xmlname": "offeringType" }, "RecurringCharges": { "shape_name": "RecurringChargesList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "Frequency": { "shape_name": "RecurringChargeFrequency", "type": "string", "enum": [ "Hourly" ], "documentation": "\n The frequency of the recurring charge.\n ", "xmlname": "frequency" }, "Amount": { "shape_name": "Double", "type": "double", "documentation": "\n The amount of the recurring charge.\n ", "xmlname": "amount" } }, "documentation": "\n Represents a usage charge for Amazon EC2 resources that repeats on a schedule.\n ", "xmlname": "item" }, "documentation": "\n\tThe recurring charge tag assigned to the resource.\n ", "xmlname": "recurringCharges" } }, "documentation": "\n

\n A group of Amazon EC2 Reserved Instances purchased by this account.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described Reserved Instances.\n

\n ", "xmlname": "reservedInstancesSet" } }, "documentation": "\n

\n The result of describing the purchased Reserved Instances for your\n account.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeReservedInstances operation describes Reserved Instances\n that were purchased for use with your account.\n

\n ", "filters": { "availability-zone": { "documentation": "The Availability Zone where the Reserved Instance can be used." }, "duration": { "choices": [ "31536000", "94608000" ], "documentation": "The duration of the Reserved Instance (one year or three years), in seconds." }, "fixed-price": { "documentation": "The purchase price of the Reserved Instance (for example, 9800.0 )" }, "instance-type": { "documentation": "The instance type on which the Reserved Instance can be used." }, "product-description": { "choices": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "The product description of the Reserved Instance." }, "reserved-instances-id": { "documentation": "The ID of the Reserved Instance." }, "start": { "documentation": "The time at which the Reserved Instance purchase request was placed (for example, 2010-08-07T11:54:42.000Z)." }, "state": { "choices": [ "pending-payment", "active", "payment-failed", "retired" ], "documentation": "The state of the Reserved Instance." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "usage-price": { "documentation": "The usage price of the Reserved Instance, per hour (for example, 0.84 )" } } }, "DescribeReservedInstancesListings": { "name": "DescribeReservedInstancesListings", "input": { "shape_name": "DescribeReservedInstancesListingsRequest", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null }, "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": null }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n " }, "documentation": null, "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeReservedInstancesListingsResult", "type": "structure", "members": { "ReservedInstancesListings": { "shape_name": "ReservedInstancesListingList", "type": "list", "members": { "shape_name": "ReservedInstancesListing", "type": "structure", "members": { "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": null, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "InstanceCounts": { "shape_name": "InstanceCountList", "type": "list", "members": { "shape_name": "InstanceCount", "type": "structure", "members": { "State": { "shape_name": "ListingState", "type": "string", "enum": [ "available", "sold", "cancelled", "pending" ], "documentation": null, "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "instanceCount" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": null, "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": null, "xmlname": "currencyCode" }, "Active": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "active" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "clientToken" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "reservedInstancesListingsSet" } }, "documentation": null }, "errors": [], "documentation": null, "filters": { "reserved-instances-id": { "documentation": "The ID of the Reserved Instances." }, "reserved-instances-listing-id": { "documentation": "The ID of the Reserved Instances listing." }, "status": { "documentation": "Status of the Reserved Instance listing." }, "status-message": { "documentation": "Reason for the status." } } }, "DescribeReservedInstancesModifications": { "name": "DescribeReservedInstancesModifications", "input": { "shape_name": "DescribeReservedInstancesModificationsRequest", "type": "structure", "members": { "ReservedInstancesModificationIds": { "shape_name": "ReservedInstancesModificationIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReservedInstancesModificationId" }, "documentation": "\n

\n An optional list of Reserved Instances modification IDs to describe.\n

\n ", "flattened": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n A string specifying the next paginated set of results to return.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for ReservedInstancesModifications.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the modifications made to Reserved Instances in\n your account.\n

\n " }, "output": { "shape_name": "DescribeReservedInstancesModificationsResult", "type": "structure", "members": { "ReservedInstancesModifications": { "shape_name": "ReservedInstancesModificationList", "type": "list", "members": { "shape_name": "ReservedInstancesModification", "type": "structure", "members": { "ReservedInstancesModificationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID for the submitted modification request.\n

\n ", "xmlname": "reservedInstancesModificationId" }, "ReservedInstancesIds": { "shape_name": "ReservedIntancesIds", "type": "list", "members": { "shape_name": "ReservedInstancesId", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "reservedInstancesId" } }, "documentation": null, "xmlname": "item" }, "documentation": "\n

\n The IDs of the Reserved Instances submitted for modification.\n

\n ", "xmlname": "reservedInstancesSet" }, "ModificationResults": { "shape_name": "ReservedInstancesModificationResultList", "type": "list", "members": { "shape_name": "ReservedInstancesModificationResult", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID for the Reserved Instances created as part of the modification request.\n

\n ", "xmlname": "reservedInstancesId" }, "TargetConfiguration": { "shape_name": "ReservedInstancesConfiguration", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone for the modified Reserved Instances.\n

\n ", "xmlname": "availabilityZone" }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\n

\n The network platform of the modified Reserved Instances, which is either\n EC2-Classic or EC2-VPC.\n

\n ", "xmlname": "platform" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of modified Reserved Instances.\n

\n ", "xmlname": "instanceCount" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type for the modified Reserved Instances.\n

\n ", "xmlname": "instanceType" } }, "documentation": "\n

\n The configuration settings for the modified Reserved Instances.\n

\n ", "xmlname": "targetConfiguration" } }, "documentation": "\n

\n The resulting information about the modified Reserved Instances.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The resulting information about the modified Reserved Instances.\n

\n ", "xmlname": "modificationResultSet" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time the modification request was created.\n

\n ", "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time the modification request was last updated.\n

\n ", "xmlname": "updateDate" }, "EffectiveDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time the modification becomes effective.\n

\n ", "xmlname": "effectiveDate" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the modification request, which can be any of the following\n values: processing, fulfilled, failed.\n

\n ", "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\n

\n The reason for the status.\n

\n ", "xmlname": "statusMessage" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n The idempotency token for the modification request.\n

\n ", "xmlname": "clientToken" } }, "documentation": "\n

\n Information about a specific modification request to your Reserved Instances.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of Reserved Instances modification requests.\n

\n ", "xmlname": "reservedInstancesModificationsSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n The string specifying the next paginated set of results to return.\n

\n ", "xmlname": "nextToken" } }, "documentation": "\n

\n The result of describing Reserved Instances modifications.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeReservedInstancesModifications operation describes modifications\n made to Reserved Instances in your account.\n

\n " }, "DescribeReservedInstancesOfferings": { "name": "DescribeReservedInstancesOfferings", "input": { "shape_name": "DescribeReservedInstancesOfferingsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ReservedInstancesOfferingIds": { "shape_name": "ReservedInstancesOfferingIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReservedInstancesOfferingId" }, "documentation": "\n

\n An optional list of the unique IDs of the Reserved Instance offerings to\n describe.\n

\n ", "flattened": true }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type on which the Reserved Instance can be used.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the Reserved Instance can be used.\n

\n " }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\n

\n The Reserved Instance product description.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for ReservedInstancesOfferings.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The tenancy of the Reserved Instance offering. A Reserved Instance with tenancy of dedicated will run on single-tenant hardware and can only be launched within a VPC.\n

\n " }, "OfferingType": { "shape_name": "OfferingTypeValues", "type": "string", "enum": [ "Heavy Utilization", "Medium Utilization", "Light Utilization" ], "documentation": "\n\tThe Reserved Instance offering type.\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": null }, "IncludeMarketplace": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Include Marketplace offerings in the response.\n

\n " }, "MinDuration": { "shape_name": "Long", "type": "long", "documentation": "\n

\n Minimum duration (in seconds) to filter when searching for offerings.\n

\n " }, "MaxDuration": { "shape_name": "Long", "type": "long", "documentation": "\n

\n Maximum duration (in seconds) to filter when searching for offerings.\n

\n " }, "MaxInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n Request to describe the Reserved Instance offerings that are available for\n purchase.\n

\n

\n With Amazon EC2 Reserved Instances, you purchase the right to launch\n Amazon EC2 instances for a period of time\n (without getting insufficient capacity errors) and pay a lower usage rate for\n the actual time used.\n

\n " }, "output": { "shape_name": "DescribeReservedInstancesOfferingsResult", "type": "structure", "members": { "ReservedInstancesOfferings": { "shape_name": "ReservedInstancesOfferingList", "type": "list", "members": { "shape_name": "ReservedInstancesOffering", "type": "structure", "members": { "ReservedInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this Reserved Instances offering.\n

\n ", "xmlname": "reservedInstancesOfferingId" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type on which the Reserved Instances can be used.\n

\n ", "xmlname": "instanceType" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the Reserved Instances can be used.\n

\n ", "xmlname": "availabilityZone" }, "Duration": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The duration of the Reserved Instance, in seconds.\n

\n ", "xmlname": "duration" }, "UsagePrice": { "shape_name": "Float", "type": "float", "documentation": "\n

\n The usage price of the Reserved Instance, per hour.\n

\n ", "xmlname": "usagePrice" }, "FixedPrice": { "shape_name": "Float", "type": "float", "documentation": "\n

\n The purchase price of the Reserved Instance.\n

\n ", "xmlname": "fixedPrice" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\n

\n The Reserved Instances description (ex: Windows or Unix/Linux).\n

\n ", "xmlname": "productDescription" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The tenancy of the reserved instance (ex: default or dedicated).\n

\n ", "xmlname": "instanceTenancy" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\n

\n The currency of the reserved instance. Specified using ISO 4217 standard (e.g., USD, JPY).\n

\n ", "xmlname": "currencyCode" }, "OfferingType": { "shape_name": "OfferingTypeValues", "type": "string", "enum": [ "Heavy Utilization", "Medium Utilization", "Light Utilization" ], "documentation": "\n\tThe Reserved Instance offering type.\n ", "xmlname": "offeringType" }, "RecurringCharges": { "shape_name": "RecurringChargesList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "Frequency": { "shape_name": "RecurringChargeFrequency", "type": "string", "enum": [ "Hourly" ], "documentation": "\n The frequency of the recurring charge.\n ", "xmlname": "frequency" }, "Amount": { "shape_name": "Double", "type": "double", "documentation": "\n The amount of the recurring charge.\n ", "xmlname": "amount" } }, "documentation": "\n Represents a usage charge for Amazon EC2 resources that repeats on a schedule.\n ", "xmlname": "item" }, "documentation": "\n\tThe recurring charge tag assigned to the resource.\n ", "xmlname": "recurringCharges" }, "Marketplace": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "marketplace" }, "PricingDetails": { "shape_name": "PricingDetailsList", "type": "list", "members": { "shape_name": "PricingDetail", "type": "structure", "members": { "Price": { "shape_name": "Double", "type": "double", "documentation": null, "xmlname": "price" }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "count" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "pricingDetailsSet" } }, "documentation": "\n

\n An active offer for Amazon EC2 Reserved Instances.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described Reserved Instance offerings.\n

\n ", "xmlname": "reservedInstancesOfferingsSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "nextToken" } }, "documentation": "\n

\n The result of describing Reserved Instance offerings.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeReservedInstancesOfferings operation describes Reserved\n Instance offerings that are available for purchase. With Amazon EC2\n Reserved Instances, you purchase the right to launch Amazon EC2 instances\n for a period of time (without getting insufficient capacity errors) and\n pay a lower usage rate for the actual time used.\n

\n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "ReservedInstancesOfferings", "py_input_token": "next_token" }, "filters": { "availability-zone": { "documentation": "The Availability Zone where the Reserved Instance can be used." }, "duration": { "choices": [ "31536000", "94608000" ], "documentation": "The duration of the Reserved Instance (for example, one year or three years), in seconds." }, "fixed-price": { "documentation": "The purchase price of the Reserved Instance (for example, 9800.0 )" }, "instance-type": { "documentation": "The Amazon EC2 instance type on which the Reserved Instance can be used." }, "product-description": { "choices": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "The description of the Reserved Instance." }, "reserved-instances-offering-id": { "documentation": "The Reserved Instances offering ID." }, "usage-price": { "documentation": "The usage price of the Reserved Instance, per hour (for example, 0.84 )" } } }, "DescribeRouteTables": { "name": "DescribeRouteTables", "input": { "shape_name": "DescribeRouteTablesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RouteTableIds": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "RouteTableId" }, "documentation": "\n\t\t

\n\t\tOne or more route table IDs.\n\t\t

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n\t\t

\n\t\tA list of filters used to match properties for Route Tables.\n\t\tFor a complete reference to the available filter keys for this operation, see the\n\t\tAmazon EC2 API reference.\n\t\t

\n ", "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeRouteTablesResult", "type": "structure", "members": { "RouteTables": { "shape_name": "RouteTableList", "type": "list", "members": { "shape_name": "RouteTable", "type": "structure", "members": { "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "Routes": { "shape_name": "RouteList", "type": "list", "members": { "shape_name": "Route", "type": "structure", "members": { "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "destinationCidrBlock" }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "gatewayId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceOwnerId" }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "State": { "shape_name": "RouteState", "type": "string", "enum": [ "active", "blackhole" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "routeSet" }, "Associations": { "shape_name": "RouteTableAssociationList", "type": "list", "members": { "shape_name": "RouteTableAssociation", "type": "structure", "members": { "RouteTableAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableAssociationId" }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "routeTableId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "Main": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "main" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" }, "PropagatingVgws": { "shape_name": "PropagatingVgwList", "type": "list", "members": { "shape_name": "PropagatingVgw", "type": "structure", "members": { "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "gatewayId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "propagatingVgwSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "routeTableSet" } }, "documentation": null }, "errors": [], "documentation": "\n\t\t

\n\t\tGives you information about your route tables. You can filter the results to return information only\n\t\tabout tables that match criteria you specify. For example, you could get information only about a\n\t\ttable associated with a particular subnet. You can specify multiple values for the filter. The table\n\t\tmust match at least one of the specified values for it to be included in the results.\n\t\t

\n\t\t

\n\t\tYou can specify multiple filters (e.g., the table has a particular route, and is associated with a\n\t\tparticular subnet). The result includes information for a particular table only if it matches all\n\t\tyour filters. If there's no match, no special message is returned; the response is simply empty.\n\t\t

\n\t\t

\n\t\tYou can use wildcards with the filter values: an asterisk matches zero or more characters, and\n\t\t? matches exactly one character. You can escape special characters using a backslash\n\t\tbefore the character. For example, a value of \\*amazon\\?\\\\ searches for the literal\n\t\tstring *amazon?\\.\n\t\t

\n ", "filters": { "association.main": { "documentation": "Indicates whether the route table is the main route table for the VPC." }, "association.route-table-association-id": { "documentation": "The ID of an association ID for the route table." }, "association.route-table-id": { "documentation": "The ID of the route table involved in the association." }, "association.subnet-id": { "documentation": "The ID of the subnet involved in the association." }, "route-table-id": { "documentation": "The ID of the route table." }, "route.destination-cidr-block": { "documentation": "The CIDR range specified in a route in the table." }, "route.gateway-id": { "documentation": "The ID of a gateway specified in a route in the table." }, "route.instance-id": { "documentation": "The ID of an instance specified in a route in the table." }, "route.origin": { "documentation": "Describes how the route was created." }, "route.state": { "choices": [ "active", "blackhole" ], "documentation": "The state of a route in the route table. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on)." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "vpc-id": { "documentation": "The ID of the VPC for the route table." } } }, "DescribeSecurityGroups": { "name": "DescribeSecurityGroups", "input": { "shape_name": "DescribeSecurityGroupsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupNames": { "shape_name": "GroupNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupName" }, "documentation": "\n

\n An optional list of group names that specify the Amazon EC2 security groups to describe.\n

\n ", "flattened": true }, "GroupIds": { "shape_name": "GroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupId" }, "documentation": null, "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for SecurityGroups.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the Amazon EC2 security groups for your account.\n

\n " }, "output": { "shape_name": "DescribeSecurityGroupsResult", "type": "structure", "members": { "SecurityGroups": { "shape_name": "SecurityGroupList", "type": "list", "members": { "shape_name": "SecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS Access Key ID of the owner of the security group.\n

\n ", "xmlname": "ownerId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of this security group.\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of this security group.\n

\n ", "xmlname": "groupDescription" }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n ", "xmlname": "ipProtocol" }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n ", "xmlname": "fromPort" }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n ", "xmlname": "toPort" }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n ", "xmlname": "userId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n ", "xmlname": "groupId" } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "xmlname": "groups" }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n ", "xmlname": "cidrIp" } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "xmlname": "ipRanges" } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The permissions enabled for this security group.\n

\n ", "xmlname": "ipPermissions" }, "IpPermissionsEgress": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n ", "xmlname": "ipProtocol" }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n ", "xmlname": "fromPort" }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n ", "xmlname": "toPort" }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n ", "xmlname": "userId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n ", "xmlname": "groupId" } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "xmlname": "groups" }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n ", "xmlname": "cidrIp" } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "xmlname": "ipRanges" } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "ipPermissionsEgress" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": "\n

\n An Amazon EC2 security group, describing how EC2 instances in this group\n can receive network traffic.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described Amazon EC2 security groups.\n

\n ", "xmlname": "securityGroupInfo" } }, "documentation": "\n

\n The result of describing the Amazon EC2 security groups for your account.\n

\n " }, "errors": [], "documentation": "\n

\n The DescribeSecurityGroups operation returns information about security groups\n that you own.\n

\n

\n If you specify security group names, information about those security group is\n returned. Otherwise, information for all security group is returned. If you\n specify a group that does not exist, a fault is returned.\n

\n ", "filters": { "description": { "documentation": "The description of the security group." }, "group-id": { "documentation": "The ID of the security group." }, "group-name": { "documentation": "The name of the security group." }, "ip-permission.cidr": { "documentation": "The CIDR range that has been granted the permission." }, "ip-permission.from-port": { "documentation": "The start of port range for the TCP and UDP protocols, or an ICMP type number." }, "ip-permission.group-name": { "documentation": "The name of security group that has been granted the permission." }, "ip-permission.protocol": { "choices": [ "tcp", "udp", "icmp" ], "documentation": "The IP protocol for the permission." }, "ip-permission.to-port": { "documentation": "The end of port range for the TCP and UDP protocols, or an ICMP code." }, "ip-permission.user-id": { "documentation": "The ID of an AWS account that has been granted the permission." }, "owner-id": { "documentation": "The AWS account ID of the owner of the security group." }, "tag-key": { "documentation": "The key of a tag assigned to the security group." }, "tag-value": { "documentation": "The value of a tag assigned to the security group." }, "vpc-id": { "documentation": "Only return the security groups that belong to the specified EC2-VPC ID." } } }, "DescribeSnapshotAttribute": { "name": "DescribeSnapshotAttribute", "input": { "shape_name": "DescribeSnapshotAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS snapshot whose attribute is being described.\n

\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\n

\n The name of the EBS attribute to describe.\n

\n

\n Available attribute names: createVolumePermission\n

\n ", "required": true } }, "documentation": "\n

\n A request to describe an attribute of an EBS snapshot. Only one\n attribute can be specified per request.\n

\n " }, "output": { "shape_name": "DescribeSnapshotAttributeResult", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot whose attribute is being described.\n

\n ", "xmlname": "snapshotId" }, "CreateVolumePermissions": { "shape_name": "CreateVolumePermissionList", "type": "list", "members": { "shape_name": "CreateVolumePermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The user ID of the user that can create volumes from the snapshot.\n

\n ", "xmlname": "userId" }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The group that is allowed to create volumes from the snapshot (currently\n supports \"all\").\n

\n ", "xmlname": "group" } }, "documentation": "\n

\n Describes a permission allowing either a user or group to create a new EBS\n volume from a snapshot.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of permissions describing who can create a volume from the\n associated EBS snapshot.\n

\n

\n Only available if the createVolumePermission attribute is requested.\n

\n ", "xmlname": "createVolumePermission" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "productCodes" } }, "documentation": "\n

\n The result of describing an EBS snapshot attribute.\n

\n " }, "errors": [], "documentation": "\n

\n Returns information about an attribute of a snapshot. Only one attribute can\n be specified per call.\n

\n " }, "DescribeSnapshots": { "name": "DescribeSnapshots", "input": { "shape_name": "DescribeSnapshotsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SnapshotIds": { "shape_name": "SnapshotIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SnapshotId" }, "documentation": "\n

\n The optional list of EBS snapshot IDs to describe.\n

\n ", "flattened": true }, "OwnerIds": { "shape_name": "OwnerStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Owner" }, "documentation": "\n

\n An optional list of owners by which to scope the described EBS\n snapshots. Valid values are:\n

\n \n

\n The values self and amazon are literals.\n

\n ", "flattened": true }, "RestorableByUserIds": { "shape_name": "RestorableByStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "RestorableBy" }, "documentation": "\n

\n An optional list of users. The described snapshots are scoped to only those\n snapshots from which these users can create volumes.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Snapshots.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe Amazon EBS snapshots available to your account.\n Information returned includes volume ID, status, start time,\n progress, owner ID, volume size, and description.\n

\n

\n Snapshots available to your account include public snapshots available for any\n user to launch, private snapshots\n owned by the user making the request, and private snapshots owned by other\n users for which the user granted explicit create volume\n permissions.\n

\n " }, "output": { "shape_name": "DescribeSnapshotsResult", "type": "structure", "members": { "Snapshots": { "shape_name": "SnapshotList", "type": "list", "members": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this snapshot.\n

\n ", "xmlname": "snapshotId" }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the volume from which this snapshot was created.\n

\n ", "xmlname": "volumeId" }, "State": { "shape_name": "SnapshotState", "type": "string", "enum": [ "pending", "completed", "error" ], "documentation": "\n

\n Snapshot state (e.g., pending, completed, or error).\n

\n ", "xmlname": "status" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Time stamp when the snapshot was initiated.\n

\n ", "xmlname": "startTime" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\n

\n The progress of the snapshot, in percentage.\n

\n ", "xmlname": "progress" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n AWS Access Key ID of the user who owns the snapshot.\n

\n ", "xmlname": "ownerId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Description of the snapshot.\n

\n\n ", "xmlname": "description" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "OwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS account alias (e.g., \"amazon\", \"redhat\", \"self\", etc.) or AWS\n account ID that owns the AMI.\n

\n ", "xmlname": "ownerAlias" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Snapshot.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n Represents a snapshot of an Amazon EC2 EBS volume.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described EBS snapshots.\n

\n ", "xmlname": "snapshotSet" } }, "documentation": "\n

\n The result of describing EBS snapshots.\n

\n " }, "errors": [], "documentation": "\n

\n Returns information about the Amazon EBS snapshots available to you.\n Snapshots available to you include public snapshots available for any AWS account to launch, private snapshots you own,\n and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.\n

\n ", "filters": { "description": { "documentation": "A description of the snapshot." }, "owner-alias": { "documentation": "The AWS account alias (for example, amazon ) that owns the snapshot." }, "owner-id": { "documentation": "The ID of the AWS account that owns the snapshot." }, "progress": { "documentation": "The progress of the snapshot, as a percentage (for example, 80% )." }, "snapshot-id": { "documentation": "The snapshot ID." }, "start-time": { "documentation": "The time stamp when the snapshot was initiated." }, "status": { "choices": [ "pending", "completed", "error" ], "documentation": "The status of the snapshot." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "volume-id": { "documentation": "The ID of the volume the snapshot is for." }, "volume-size": { "documentation": "The size of the volume, in GiB (for example, 20 )." } } }, "DescribeSpotDatafeedSubscription": { "name": "DescribeSpotDatafeedSubscription", "input": { "shape_name": "DescribeSpotDatafeedSubscriptionRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeSpotDatafeedSubscriptionResult", "type": "structure", "members": { "SpotDatafeedSubscription": { "shape_name": "SpotDatafeedSubscription", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS account ID of the account.\n

\n ", "xmlname": "ownerId" }, "Bucket": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon S3 bucket where the Spot Instance data feed is located.\n

\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the prefix that is prepended to data feed files.\n

\n ", "xmlname": "prefix" }, "State": { "shape_name": "DatafeedSubscriptionState", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n

\n Specifies the state of the Spot Instance request.\n

\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": "\n

\n Specifies a fault code for the Spot Instance request, if present.\n

\n ", "xmlname": "fault" } }, "documentation": "\n

\n The Spot Instance datafeed subscription.\n

\n ", "xmlname": "spotDatafeedSubscription" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Describes the data feed for Spot Instances.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n " }, "DescribeSpotInstanceRequests": { "name": "DescribeSpotInstanceRequests", "input": { "shape_name": "DescribeSpotInstanceRequestsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SpotInstanceRequestIds": { "shape_name": "SpotInstanceRequestIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SpotInstanceRequestId" }, "documentation": "\n

\n The ID of the request.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for SpotInstances.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": null }, "output": { "shape_name": "DescribeSpotInstanceRequestsResult", "type": "structure", "members": { "SpotInstanceRequests": { "shape_name": "SpotInstanceRequestList", "type": "list", "members": { "shape_name": "SpotInstanceRequest", "type": "structure", "members": { "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotInstanceRequestId" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotPrice" }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": null, "xmlname": "type" }, "State": { "shape_name": "SpotInstanceState", "type": "string", "enum": [ "open", "active", "closed", "cancelled", "failed" ], "documentation": null, "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": null, "xmlname": "fault" }, "Status": { "shape_name": "SpotInstanceStatus", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "updateTime" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": null, "xmlname": "status" }, "ValidFrom": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "validFrom" }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "validUntil" }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "launchGroup" }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZoneGroup" }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AMI ID.\n

\n ", "xmlname": "imageId" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n ", "xmlname": "keyName" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\n

\n Optional data, specific to a user's application, to provide in the launch request.\n All instances that collectively comprise the launch request have access to this data.\n User data is never returned through API responses.\n

\n ", "xmlname": "userData" }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Deprecated.\n

\n ", "xmlname": "addressingType" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n Specifies the instance type.\n

\n ", "xmlname": "instanceType" }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n ", "xmlname": "groupName" } }, "documentation": "\n

\n Defines a placement item.\n

\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the kernel to select.\n

\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the RAM disk to select.\n Some kernels require additional drivers at launch.\n Check the kernel requirements for information on whether\n or not you need to specify a RAM disk and search for the kernel ID.\n

\n ", "xmlname": "ramdiskId" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n ", "xmlname": "noDevice" } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n

\n ", "xmlname": "blockDeviceMapping" }, "MonitoringEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Enables monitoring for the instance.\n

\n ", "xmlname": "monitoringEnabled" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC subnet ID within which to launch the instance(s)\n for Amazon Virtual Private Cloud.\n

\n ", "xmlname": "subnetId" }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceSpecificationList", "type": "list", "members": { "shape_name": "InstanceNetworkInterfaceSpecification", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n

An existing interface to attach to a single instance. Requires n=1\n instances.

\n ", "xmlname": "networkInterfaceId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The device index. Applies to both attaching an existing network interface and when\n creating a network interface.

\n

Condition: If you are specifying a network interface in the\n request, you must provide the device index.

\n ", "xmlname": "deviceIndex" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The subnet ID. Applies only when creating a network interface.

\n ", "xmlname": "subnetId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description. Applies only when creating a network interface.

\n ", "xmlname": "description" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The primary private IP address. \n Applies only when creating a network interface. \n Requires n=1 network interfaces in launch.

\n

\n ", "xmlname": "privateIpAddress" }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "xmlname": "SecurityGroupId" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressSpecificationList", "type": "list", "members": { "shape_name": "PrivateIpAddressSpecification", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "privateIpAddress" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether to assign a public IP address to an instance in a VPC. The public IP\n address is associated with a specific network interface. If set to true,\n the following rules apply:\n

\n
    \n
  1. \n

    Can only be associated with a single network interface with\n the device index of 0. You can't associate a public IP address\n with a second network interface, and you can't associate a\n public IP address if you are launching more than one network\n interface.

    \n
    2. \n
  2. \n

    Can only be associated with a new network interface, \n not an existing one.

    \n
    3. \n
\n

\n Default: If launching into a default subnet, the default value is true.\n If launching into a nondefault subnet, the default value is\n false. \n

\n ", "xmlname": "associatePublicIpAddress" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "arn" }, "Name": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "name" } }, "documentation": null, "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "ebsOptimized" } }, "documentation": "\n

\n The LaunchSpecificationType data type.\n

\n ", "xmlname": "launchSpecification" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "createTime" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": null, "xmlname": "productDescription" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for this spot instance request.\n

\n ", "xmlname": "tagSet" }, "LaunchedAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the bid is launched.\n

\n ", "xmlname": "launchedAvailabilityZone" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "spotInstanceRequestSet" } }, "documentation": null }, "errors": [], "documentation": "\n

\n\t\tDescribes Spot Instance requests. Spot Instances are instances that\n\t\tAmazon EC2 starts on your behalf when the maximum price that you specify\n\t\texceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price\n\t\tbased on available Spot Instance capacity and current spot instance requests.\n\t\tFor conceptual information about Spot Instances, refer to the\n\t\t\n\t\tAmazon Elastic Compute Cloud Developer Guide\n\t\tor\n\t\t\n\t\tAmazon Elastic Compute Cloud User Guide.\n\t\t

\n\t\t

\n\t\tYou can filter the results to return information only about\n\t\tSpot Instance requests that match criteria you specify. For example,\n\t\tyou could get information about requests where the Spot Price you specified\n\t\tis a certain value (you can't use greater than or less than comparison,\n\t\tbut you can use * and ? wildcards).\n\t\tYou can specify multiple values for a filter.\n\t\tA Spot Instance request must match at least one of the specified values for it to\n\t\tbe included in the results.\n\t\t

\n\t\t

\n\t\tYou can specify multiple filters (e.g., the Spot Price is equal to a particular value,\n\t\tand the instance type is m1.small). The result includes information for a particular\n\t\trequest only if it matches all your filters. If there's no match, no special message\n\t\tis returned; the response is simply empty.\n\t\t

\n\t\t

\n\t\tYou can use wildcards with the filter values: an asterisk matches zero or more characters,\n\t\tand ? matches exactly one character. You can escape special characters using a\n\t\tbackslash before the character. For example, a value of \\*amazon\\?\\\\ searches for the\n\t\tliteral string *amazon?\\.\n\t\t

\n ", "filters": { "availability-zone-group": { "documentation": "The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone." }, "create-time": { "documentation": "The time stamp when the Spot Instance request was created." }, "fault-code": { "documentation": "The fault code related to the request." }, "fault-message": { "documentation": "The fault message related to the request." }, "instance-id": { "documentation": "The ID of the instance that fulfilled the request." }, "launch-group": { "documentation": "The Spot Instance launch group. Launch groups are Spot Instances that launch together and terminate together." }, "launch.block-device-mapping.delete-on-termination": { "documentation": "Whether the Amazon EBS volume is deleted on instance termination." }, "launch.block-device-mapping.device-name": { "documentation": "The device name (for example, /dev/sdh) for the Amazon EBS volume." }, "launch.block-device-mapping.snapshot-id": { "documentation": "The ID of the snapshot used for the Amazon EBS volume." }, "launch.block-device-mapping.volume-size": { "documentation": "The volume size of the Amazon EBS volume, in GiB." }, "launch.block-device-mapping.volume-type": { "choices": [ "standard", "io1" ], "documentation": "The volume type of the Amazon EBS volume." }, "launch.group-id": { "documentation": "The security group for the instance." }, "launch.image-id": { "documentation": "The ID of the AMI." }, "launch.instance-type": { "documentation": "The type of instance (for example, m1.small)." }, "launch.kernel-id": { "documentation": "The kernel ID." }, "launch.key-name": { "documentation": "The name of the key pair the instance launched with." }, "launch.monitoring-enabled": { "documentation": "Whether monitoring is enabled for the Spot Instance." }, "launch.network-interface.addresses.primary": { "documentation": "Indicates whether the IP address is the primary private IP address." }, "launch.network-interface.delete-on-termination": { "documentation": "Indicates whether the network interface is deleted when the instance is terminated." }, "launch.network-interface.description": { "documentation": "A description of the network interface." }, "launch.network-interface.device-index": { "documentation": "The index of the device for the network interface attachment on the instance." }, "launch.network-interface.group-id": { "documentation": "The ID of the security group associated with the network interface." }, "launch.network-interface.group-name": { "documentation": "The name of the security group associated with the network interface." }, "launch.network-interface.network-interface-id": { "documentation": "The ID of the network interface." }, "launch.network-interface.private-ip-address": { "documentation": "The primary private IP address of the network interface." }, "launch.network-interface.subnet-id": { "documentation": "The ID of the subnet for the instance." }, "launch.ramdisk-id": { "documentation": "The RAM disk ID." }, "launched-availability-zone": { "choices": [ "us-east-1a" ], "documentation": "The Availability Zone in which the bid is launched." }, "product-description": { "choices": [ "Linux/UNIX", "Windows" ], "documentation": "The product description associated with the instance." }, "spot-instance-request-id": { "documentation": "The Spot Instance request ID." }, "spot-price": { "documentation": "The maximum hourly price for any Spot Instance launched to fulfill the request." }, "state": { "choices": [ "open", "active", "closed", "cancelled", "failed" ], "documentation": "The state of the Spot Instance request. Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide ." }, "status-code": { "documentation": "The short code describing the most recent evaluation of your Spot Instance request. For more information, see Spot Bid Status in the ." }, "status-message": { "documentation": "The message explaining the status of the Spot Instance request." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "type": { "choices": [ "one-time", "persistent" ], "documentation": "The type of Spot Instance request." }, "valid-from": { "documentation": "The start date of the request." }, "valid-until": { "documentation": "The end date of the request." } } }, "DescribeSpotPriceHistory": { "name": "DescribeSpotPriceHistory", "input": { "shape_name": "DescribeSpotPriceHistoryRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The start date and time of the Spot Instance price history data.\n

\n " }, "EndTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The end date and time of the Spot Instance price history data.\n

\n " }, "InstanceTypes": { "shape_name": "InstanceTypeList", "type": "list", "members": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": null, "xmlname": "InstanceType" }, "documentation": "\n

\n Specifies the instance type to return.\n

\n ", "flattened": true }, "ProductDescriptions": { "shape_name": "ProductDescriptionList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ProductDescription" }, "documentation": "\n

\n The description of the AMI.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for SpotPriceHistory.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tFilters the results by availability zone (ex: 'us-east-1a').\n

\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n\t\tSpecifies the number of rows to return.\n

\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the next set of rows to return.\n

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeSpotPriceHistoryResult", "type": "structure", "members": { "SpotPriceHistory": { "shape_name": "SpotPriceHistoryList", "type": "list", "members": { "shape_name": "SpotPrice", "type": "structure", "members": { "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": null, "xmlname": "instanceType" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": null, "xmlname": "productDescription" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotPrice" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "timestamp" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZone" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "spotPriceHistorySet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n The string marking the next set of results returned. Displays empty if there are no more results to be returned.\n

\n ", "xmlname": "nextToken" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Describes the Spot Price history.\n

\n

\n Spot Instances are instances that Amazon EC2\n starts on your behalf when the maximum price\n that you specify exceeds the current Spot Price.\n Amazon EC2 periodically sets the Spot Price based\n on available Spot Instance capacity and current\n spot instance requests.\n

\n

\n For conceptual information about Spot Instances,\n refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide\n .\n

\n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "SpotPriceHistory", "py_input_token": "next_token" }, "filters": { "availability-zone": { "documentation": "The Availability Zone for which prices should be returned." }, "instance-type": { "documentation": "The type of instance (for example, m1.small)." }, "product-description": { "choices": [ "Linux/UNIX", "SUSE Linux", "Windows", "Linux/UNIX (Amazon VPC)", "SUSE Linux (Amazon VPC)", "Windows (Amazon VPC)" ], "documentation": "The product description for the Spot Price." }, "spot-price": { "documentation": "The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported)." }, "timestamp": { "documentation": "The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported." } } }, "DescribeSubnets": { "name": "DescribeSubnets", "input": { "shape_name": "DescribeSubnetsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SubnetIds": { "shape_name": "SubnetIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetId" }, "documentation": "\n

\n A set of one or more subnet IDs.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Subnets.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DescribeSubnetsResult", "type": "structure", "members": { "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the subnet.\n

\n ", "xmlname": "subnetId" }, "State": { "shape_name": "SubnetState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n

\n Describes the current state of the subnet.\n The state of the subnet may be either\n pending or\n available.\n

\n ", "xmlname": "state" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the ID of the VPC the subnet is in.\n

\n ", "xmlname": "vpcId" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the CIDR block assigned to the subnet.\n

\n ", "xmlname": "cidrBlock" }, "AvailableIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of unused IP addresses in the subnet.\n

\n \n

\n The IP addresses for any stopped instances are\n considered unavailable.\n

\n \n ", "xmlname": "availableIpAddressCount" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Availability Zone the subnet is in.\n

\n ", "xmlname": "availabilityZone" }, "DefaultForAz": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "defaultForAz" }, "MapPublicIpOnLaunch": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "mapPublicIpOnLaunch" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Subnet.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n The Subnet data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains a set of one or more Subnet\n instances.\n

\n ", "xmlname": "subnetSet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Gives you information about your subnets. You can filter the results to return information only about\n subnets that match criteria you specify.\n\t\t

\n\t\t

\n\t\tFor example, you could ask to get information about a particular subnet (or all) only if the subnet's\n\t\tstate is available. You can specify multiple filters (e.g., the subnet is in a particular VPC, and the\n\t\tsubnet's state is available).\n\t\t

\n\t\t

\n\t\tThe result includes information for a particular subnet only if the subnet matches all your filters.\n\t\tIf there's no match, no special message is returned; the response is simply empty. The following table\n\t\tshows the available filters.\n

\n ", "filters": { "availability-zone": { "documentation": "The Availability Zone for the subnet." }, "available-ip-address-count": { "documentation": "The number of IP addresses in the subnet that are available." }, "cidr": { "documentation": "The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet." }, "state": { "choices": [ "pending", "available" ], "documentation": "The state of the subnet." }, "subnet-id": { "documentation": "The ID of the subnet." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "vpc-id": { "documentation": "The ID of the VPC for the subnet." } } }, "DescribeTags": { "name": "DescribeTags", "input": { "shape_name": "DescribeTagsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for tags.\n

\n ", "flattened": true }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": null }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": "\n

\n " }, "output": { "shape_name": "DescribeTagsResult", "type": "structure", "members": { "Tags": { "shape_name": "TagDescriptionList", "type": "list", "members": { "shape_name": "TagDescription", "type": "structure", "members": { "ResourceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The resource ID for the tag.\n

\n ", "xmlname": "resourceId" }, "ResourceType": { "shape_name": "ResourceType", "type": "string", "enum": [ "customer-gateway", "dhcp-options", "image", "instance", "internet-gateway", "network-acl", "network-interface", "reserved-instances", "route-table", "snapshot", "spot-instances-request", "subnet", "security-group", "volume", "vpc", "vpn-connection", "vpn-gateway" ], "documentation": "\n

\n The type of resource identified by the associated resource ID (ex: instance, AMI, EBS volume, etc).\n

\n ", "xmlname": "resourceType" }, "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Provides information about an Amazon EC2 resource Tag.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of the tags for the specified resources.\n

\n ", "xmlname": "tagSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "nextToken" } }, "documentation": "\n

\n " }, "errors": [], "documentation": "\n

\n Describes the tags for the specified resources.\n

\n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Tags", "py_input_token": "next_token" }, "filters": { "key": { "documentation": "The tag key." }, "resource-id": { "documentation": "The resource ID." }, "resource-type": { "choices": [ "customer-gateway", "dhcp-options", "image", "instance", "internet-gateway", "network-acl", "network-interface", "reserved-instances", "route-table", "security-group", "snapshot", "spot-instances-request", "subnet", "volume", "vpc", "vpn-connection", "vpn-gateway" ], "documentation": "The resource type." }, "value": { "documentation": "The tag value." } } }, "DescribeVolumeAttribute": { "name": "DescribeVolumeAttribute", "input": { "shape_name": "DescribeVolumeAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Attribute": { "shape_name": "VolumeAttributeName", "type": "string", "enum": [ "autoEnableIO", "productCodes" ], "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeVolumeAttributeResult", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "volumeId" }, "AutoEnableIO": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "Boolean value", "xmlname": "autoEnableIO" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "productCodes" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeVolumeStatus": { "name": "DescribeVolumeStatus", "input": { "shape_name": "DescribeVolumeStatusRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeIds": { "shape_name": "VolumeIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VolumeId" }, "documentation": null, "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": null, "flattened": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeVolumeStatusResult", "type": "structure", "members": { "VolumeStatuses": { "shape_name": "VolumeStatusList", "type": "list", "members": { "shape_name": "VolumeStatusItem", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "volumeId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZone" }, "VolumeStatus": { "shape_name": "VolumeStatusInfo", "type": "structure", "members": { "Status": { "shape_name": "VolumeStatusInfoStatus", "type": "string", "enum": [ "ok", "impaired", "insufficient-data" ], "documentation": null, "xmlname": "status" }, "Details": { "shape_name": "VolumeStatusDetailsList", "type": "list", "members": { "shape_name": "VolumeStatusDetails", "type": "structure", "members": { "Name": { "shape_name": "VolumeStatusName", "type": "string", "enum": [ "io-enabled", "io-performance" ], "documentation": null, "xmlname": "name" }, "Status": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "status" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "details" } }, "documentation": null, "xmlname": "volumeStatus" }, "Events": { "shape_name": "VolumeStatusEventsList", "type": "list", "members": { "shape_name": "VolumeStatusEvent", "type": "structure", "members": { "EventType": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "eventType" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "NotBefore": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "notBefore" }, "NotAfter": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "notAfter" }, "EventId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "eventId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "eventsSet" }, "Actions": { "shape_name": "VolumeStatusActionsList", "type": "list", "members": { "shape_name": "VolumeStatusAction", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "EventType": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "eventType" }, "EventId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "eventId" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "actionsSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "volumeStatusSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "nextToken" } }, "documentation": null }, "errors": [], "documentation": "\n

\n Describes the status of a volume.\n

\n ", "pagination": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "VolumeStatuses", "py_input_token": "next_token" }, "filters": { "action.code": { "documentation": "The action code for the event, for example, enable-volume-io" }, "action.description": { "documentation": "A description of the action." }, "action.event-id": { "documentation": "The event ID associated with the action." }, "availability-zone": { "documentation": "The Availability Zone of the instance." }, "event.description": { "documentation": "A description of the event." }, "event.event-id": { "documentation": "The event ID." }, "event.event-type": { "documentation": "The event type." }, "event.not-after": { "documentation": "The latest end time for the event." }, "event.not-before": { "documentation": "The earliest start time for the event." }, "volume-status.details-name": { "choices": [ "io-enabled", "io-performance" ], "documentation": "The cause for the volume-status.status ." }, "volume-status.details-status": { "documentation": "The status of the volume-status.details-name ." }, "volume-status.status": { "choices": [ "ok", "impaired", "warning", "insufficient-data" ], "documentation": "The status of the volume." } } }, "DescribeVolumes": { "name": "DescribeVolumes", "input": { "shape_name": "DescribeVolumesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeIds": { "shape_name": "VolumeIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VolumeId" }, "documentation": "\n

\n The optional list of EBS volumes to describe.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n

\n A list of filters used to match properties for Volumes.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to describe the Amazon EBS volumes that you own.\n If you do not specify any volume IDs, all the volumes you own will be\n described.\n

\n " }, "output": { "shape_name": "DescribeVolumesResult", "type": "structure", "members": { "Volumes": { "shape_name": "VolumeList", "type": "list", "members": { "shape_name": "Volume", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this volume.\n

\n ", "xmlname": "volumeId" }, "Size": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of this volume, in gigabytes.\n

\n ", "xmlname": "size" }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Optional snapshot from which this volume was created.\n

\n\n ", "xmlname": "snapshotId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Availability zone in which this volume was created.\n

\n ", "xmlname": "availabilityZone" }, "State": { "shape_name": "VolumeState", "type": "string", "enum": [ "creating", "available", "in-use", "deleting", "deleted", "error" ], "documentation": "\n

\n State of this volume (e.g., creating, available).\n

\n ", "xmlname": "status" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when volume creation was initiated.\n

\n ", "xmlname": "createTime" }, "Attachments": { "shape_name": "VolumeAttachmentList", "type": "list", "members": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n How the device is exposed to the instance (e.g., /dev/sdh).\n

\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when this attachment initiated.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n `

\n Whether this volume will be deleted or not when the associated instance is\n terminated.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n Specifies the details of a how an EC2 EBS volume is attached to an instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Information on what this volume is attached to.\n

\n ", "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Volume.\n

\n ", "xmlname": "tagSet" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n Represents an Amazon Elastic Block Storage (EBS) volume.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of described EBS volumes.\n

\n ", "xmlname": "volumeSet" } }, "documentation": "\n

\n The result of describing your EBS volumes.\n

\n " }, "errors": [], "documentation": "\n

\n Describes the status of the indicated volume or, in lieu of any specified,\n all volumes belonging to the caller. Volumes that have been deleted\n are not described.\n

\n ", "filters": { "attachment.attach-time": { "documentation": "The time stamp when the attachment initiated." }, "attachment.delete-on-termination": { "documentation": "Whether the volume is deleted on instance termination." }, "attachment.device": { "documentation": "The device name that is exposed to the instance (for example, /dev/sda1)." }, "attachment.instance-id": { "documentation": "The ID of the instance the volume is attached to." }, "attachment.status": { "choices": [ "attaching", "attached", "detaching", "detached" ], "documentation": "The attachment state." }, "availability-zone": { "documentation": "The Availability Zone in which the volume was created." }, "create-time": { "documentation": "The time stamp when the volume was created." }, "size": { "documentation": "The size of the volume, in GiB (for example, 20 )." }, "snapshot-id": { "documentation": "The snapshot from which the volume was created." }, "status": { "choices": [ "creating", "available", "in-use", "deleting", "deleted", "error" ], "documentation": "The status of the volume." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "volume-id": { "documentation": "The volume ID." }, "volume-type": { "choices": [ "standard", "io1" ], "documentation": "The Amazon EBS volume type. If the volume is an io1 volume, the response includes the IOPS as well." } } }, "DescribeVpcAttribute": { "name": "DescribeVpcAttribute", "input": { "shape_name": "DescribeVpcAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Attribute": { "shape_name": "VpcAttributeName", "type": "string", "enum": [ "enableDnsSupport", "enableDnsHostnames" ], "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeVpcAttributeResult", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "EnableDnsSupport": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "Boolean value", "xmlname": "enableDnsSupport" }, "EnableDnsHostnames": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value", "xmlname": "value" } }, "documentation": "Boolean value", "xmlname": "enableDnsHostnames" } }, "documentation": null }, "errors": [], "documentation": null }, "DescribeVpcs": { "name": "DescribeVpcs", "input": { "shape_name": "DescribeVpcsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpcIds": { "shape_name": "VpcIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcId" }, "documentation": "\n\t\t

\n\t\tThe ID of a VPC you want information about.\n\t\t

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n\t\t

\n\t\tA list of filters used to match properties for VPCs.\n\t\tFor a complete reference to the available filter keys for this operation, see the\n\t\tAmazon EC2 API reference.\n\t\t

\n ", "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DescribeVpcsResult", "type": "structure", "members": { "Vpcs": { "shape_name": "VpcList", "type": "list", "members": { "shape_name": "Vpc", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPC.\n

\n ", "xmlname": "vpcId" }, "State": { "shape_name": "VpcState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n

\n Describes the current state of the VPC.\n The state of the subnet may be either\n pending or\n available.\n

\n ", "xmlname": "state" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the CIDR block the VPC covers.\n

\n ", "xmlname": "cidrBlock" }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the set of DHCP options\n associated with the VPC.\n Contains a value of default\n if the default options are associated with\n the VPC.\n

\n ", "xmlname": "dhcpOptionsId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VPC.\n

\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC.\n

\n ", "xmlname": "instanceTenancy" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n\n

\n ", "xmlname": "isDefault" } }, "documentation": "\n

\n The Vpc data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n\n

\n ", "xmlname": "vpcSet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Gives you information about your VPCs. You can filter the results to return information only about\n VPCs that match criteria you specify.\n\t\t

\n\t\t

\n\t\tFor example, you could ask to get information about a particular VPC or VPCs (or all your VPCs)\n\t\tonly if the VPC's state is available. You can specify multiple filters (e.g., the VPC uses one of\n\t\tseveral sets of DHCP options, and the VPC's state is available). The result includes information\n\t\tfor a particular VPC only if the VPC matches all your filters.\n\t\t

\n\t\t

\n\t\tIf there's no match, no special message is returned; the response is simply empty. The following\n\t\ttable shows the available filters.\n

\n ", "filters": { "cidr": { "documentation": "The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC." }, "dhcp-options-id": { "documentation": "The ID of a set of DHCP options." }, "state": { "choices": [ "pending", "available" ], "documentation": "The state of the VPC." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "vpc-id": { "documentation": "The ID of the VPC." } } }, "DescribeVpnConnections": { "name": "DescribeVpnConnections", "input": { "shape_name": "DescribeVpnConnectionsRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnConnectionIds": { "shape_name": "VpnConnectionIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpnConnectionId" }, "documentation": "\n

\n A VPN connection ID. More than one may be specified per request.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n\t\t

\n\t\tA list of filters used to match properties for VPN Connections.\n\t\tFor a complete reference to the available filter keys for this operation, see the\n\t\tAmazon EC2 API reference.\n\t\t

\n ", "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DescribeVpnConnectionsResult", "type": "structure", "members": { "VpnConnections": { "shape_name": "VpnConnectionList", "type": "list", "members": { "shape_name": "VpnConnection", "type": "structure", "members": { "VpnConnectionId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPN gateway\n at the VPC end of the VPN connection.\n

\n ", "xmlname": "vpnConnectionId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n

\n Describes the current state of the VPN connection.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "CustomerGatewayConfiguration": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains configuration information in the native XML format\n for the VPN connection's customer gateway.\n

\n

\n This element is\n always present in the CreateVpnConnection response;\n however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the\n pending\n or\n available\n state.\n

\n ", "xmlname": "customerGatewayConfiguration" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n Specifies the type of VPN connection.\n

\n ", "xmlname": "type" }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies ID of the customer gateway at the end\n of the VPN connection.\n

\n ", "xmlname": "customerGatewayId" }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specfies the ID of the VPN gateway at the\n VPC end of the VPN connection.\n

\n ", "xmlname": "vpnGatewayId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VpnConnection.\n

\n ", "xmlname": "tagSet" }, "VgwTelemetry": { "shape_name": "VgwTelemetryList", "type": "list", "members": { "shape_name": "VgwTelemetry", "type": "structure", "members": { "OutsideIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "outsideIpAddress" }, "Status": { "shape_name": "TelemetryStatus", "type": "string", "enum": [ "UP", "DOWN" ], "documentation": null, "xmlname": "status" }, "LastStatusChange": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "lastStatusChange" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "AcceptedRouteCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "acceptedRouteCount" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "vgwTelemetry" }, "Options": { "shape_name": "VpnConnectionOptions", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "staticRoutesOnly" } }, "documentation": null, "xmlname": "options" }, "Routes": { "shape_name": "VpnStaticRouteList", "type": "list", "members": { "shape_name": "VpnStaticRoute", "type": "structure", "members": { "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "destinationCidrBlock" }, "Source": { "shape_name": "VpnStaticRouteSource", "type": "string", "enum": [ "Static" ], "documentation": null, "xmlname": "source" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": null, "xmlname": "state" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "routes" } }, "documentation": "\n

\n The VpnConnection data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n\n

\n ", "xmlname": "vpnConnectionSet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n

\n Gives you information about your VPN connections.\n

\n \n

\n We strongly recommend you use HTTPS when calling this operation because the response\n contains sensitive cryptographic information for configuring your customer gateway.\n

\n

\n You can filter the results to return information only about VPN connections that match criteria you\n specify. For example, you could ask to get information about a particular VPN connection (or all) only if\n the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection\n is associated with a particular VPN gateway, and the gateway's state is pending or available). The\n result includes information for a particular VPN connection only if the VPN connection matches all your\n filters. If there's no match, no special message is returned; the response is simply empty. The following\n table shows the available filters.\n

\n \n ", "filters": { "bgp-asn": { "documentation": "The BGP Autonomous System Number (ASN) associated with a BGP device." }, "customer-gateway-configuration": { "documentation": "The configuration information for the customer gateway." }, "customer-gateway-id": { "documentation": "The ID of a customer gateway associated with the VPN connection." }, "option.static-routes-only": { "documentation": "Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP)." }, "route.destination-cidr-block": { "documentation": "The destination CIDR block. This corresponds to the subnet used in a customer data center." }, "state": { "choices": [ "pending", "available", "deleting", "deleted" ], "documentation": "The state of the VPN connection." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "type": { "choices": [ "ipsec.1" ], "documentation": "The type of VPN connection. Currently the only supported type is ipsec.1 ." }, "vpn-connection-id": { "documentation": "The ID of the VPN connection." }, "vpn-gateway-id": { "documentation": "The ID of a virtual private gateway associated with the VPN connection." } } }, "DescribeVpnGateways": { "name": "DescribeVpnGateways", "input": { "shape_name": "DescribeVpnGatewaysRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnGatewayIds": { "shape_name": "VpnGatewayIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpnGatewayId" }, "documentation": "\n

\n A list of filters used to match properties for VPN Gateways.\n For a complete reference to the available filter keys for this operation, see the\n Amazon EC2 API reference.\n

\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the filter.\n

\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

\n Contains one or more values for the filter.\n

\n ", "flattened": true } }, "documentation": "\n

\n A filter used to limit results when describing tags.\n Multiple values can be specified per filter.\n A tag must match at least one of the specified values for it to be\n returned from an operation.\n

\n

\n Wildcards can be included in filter values;\n * specifies that zero or more characters\n must match, and ? specifies that exactly one\n character must match. Use a backslash to escape special characters.\n For example, a filter value of \\*amazon\\?\\\\\n specifies the literal string *amazon?\\.\n

\n ", "xmlname": "Filter" }, "documentation": "\n\t\t

\n\t\tA list of filters used to match properties for VPN Gateways.\n\t\tFor a complete reference to the available filter keys for this operation, see the\n\t\tAmazon EC2 API reference.\n\t\t

\n ", "flattened": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DescribeVpnGatewaysResult", "type": "structure", "members": { "VpnGateways": { "shape_name": "VpnGatewayList", "type": "list", "members": { "shape_name": "VpnGateway", "type": "structure", "members": { "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the VPN gateway.\n

\n ", "xmlname": "vpnGatewayId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n

\n Describes the current state of the VPN gateway.\n Valid values are\n pending,\n available,\n deleting,\n and deleted.\n

\n ", "xmlname": "state" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n

\n Specifies the type of VPN connection the VPN gateway supports.\n

\n ", "xmlname": "type" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Availability Zone where the VPN gateway was created.\n

\n ", "xmlname": "availabilityZone" }, "VpcAttachments": { "shape_name": "VpcAttachmentList", "type": "list", "members": { "shape_name": "VpcAttachment", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Contains information about the VPCs attached to the VPN gateway.\n

\n ", "xmlname": "attachments" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the VpnGateway.\n

\n ", "xmlname": "tagSet" } }, "documentation": "\n

\n The VpnGateway data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n\n

\n ", "xmlname": "vpnGatewaySet" } }, "documentation": "\n

\n\n

\n " }, "errors": [], "documentation": "\n\t\t

\n\t\tGives you information about your VPN gateways. You can filter the results to return information only\n\t\tabout VPN gateways that match criteria you specify.\n\t\t

\n\t\t

\n\t\tFor example, you could ask to get information about a particular VPN gateway (or all) only if the\n\t\tgateway's state is pending or available. You can specify multiple filters (e.g., the VPN gateway is\n\t\tin a particular Availability Zone and the gateway's state is pending or available).\n\t\t

\n\t\t

\n\t\tThe result includes information for a particular VPN gateway only if the gateway matches all your\n\t\tfilters. If there's no match, no special message is returned; the response is simply empty. The\n\t\tfollowing table shows the available filters.\n\t\t

\n ", "filters": { "attachment.state": { "choices": [ "attaching", "attached", "detaching", "detached" ], "documentation": "The current state of the attachment between the gateway and the VPC." }, "attachment.vpc-id": { "documentation": "The ID of an attached VPC." }, "availability-zone": { "documentation": "The Availability Zone for the virtual private gateway." }, "state": { "choices": [ "pending", "available", "deleting", "deleted" ], "documentation": "The state of the virtual private gateway." }, "tag-key": { "documentation": "The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \" tag-key=Purpose \" and the filter \" tag-value=X \", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the key filter later in this table." }, "tag-value": { "documentation": "The value of a tag assigned to the resource. This filter is independent of the tag-key filter." }, "tag:": { "documentation": "Filters the response based on a specific tag/value combination." }, "type": { "choices": [ "ipsec.1" ], "documentation": "The type of virtual private gateway. Currently the only supported type is ipsec.1 ." }, "vpn-gateway-id": { "documentation": "The ID of the virtual private gateway." } } }, "DetachInternetGateway": { "name": "DetachInternetGateway", "input": { "shape_name": "DetachInternetGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InternetGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of the Internet gateway to detach.\n\t\t

\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of the VPC.\n\t\t

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tDetaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC.\n\t\tThe VPC must not contain any running instances with elastic IP addresses. For more information about\n\t\tyour VPC and Internet gateway, go to Amazon Virtual Private Cloud User Guide.\n\t\t

\n\t\t

\n\t\tFor more information about Amazon Virtual Private Cloud and Internet gateways, go to the Amazon Virtual\n\t\tPrivate Cloud User Guide.\n\t\t

\n " }, "DetachNetworkInterface": { "name": "DetachNetworkInterface", "input": { "shape_name": "DetachNetworkInterfaceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "DetachVolume": { "name": "DetachVolume", "input": { "shape_name": "DetachVolumeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the volume to detach.\n

\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance from which to detach the the specified volume.\n

\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n The device name to which the volume is attached on the specified\n instance.\n

\n " }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Forces detachment if the previous detachment attempt did not occur cleanly\n (logging into an instance, unmounting the volume, and detaching\n normally).\n

\n

\n This option can lead to data loss or a corrupted file system.\n Use this option only as a last resort to detach a volume from a failed\n instance.\n The instance will not have an opportunity to flush file system caches nor\n file system meta data.\n If you use this option, you must perform file system check and repair\n procedures.\n

\n " } }, "documentation": "\n

\n A request to detaches an Amazon EBS volume from an instance.\n

\n

\n Make sure to unmount any file systems on the device within your operating\n system before detaching the volume.\n Failure to unmount file systems, or otherwise properly release the device\n from use, can result in lost data and will corrupt the file\n system.\n

\n " }, "output": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

\n How the device is exposed to the instance (e.g., /dev/sdh).\n

\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Timestamp when this attachment initiated.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n `

\n Whether this volume will be deleted or not when the associated instance is\n terminated.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n The updated EBS volume attachment information after trying to detach the\n volume from the specified instance.\n

\n ", "xmlname": "attachment" }, "errors": [], "documentation": "\n

\n Detach a previously attached volume from a running instance.\n

\n " }, "DetachVpnGateway": { "name": "DetachVpnGateway", "input": { "shape_name": "DetachVpnGatewayRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPN gateway to detach from the VPC.\n

\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the VPC to detach the VPN gateway from.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Detaches a VPN gateway from a VPC. You do this if you're planning to turn off the VPC and not use it\n anymore. You can confirm a VPN gateway has been completely detached from a VPC by describing\n the VPN gateway (any attachments to the VPN gateway are also described).\n

\n

\n You must wait for the attachment's state to switch to detached before you can delete the VPC or\n attach a different VPC to the VPN gateway.\n

\n " }, "DisableVgwRoutePropagation": { "name": "DisableVgwRoutePropagation", "input": { "shape_name": "DisableVgwRoutePropagationRequest", "type": "structure", "members": { "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "DisassociateAddress": { "name": "DisassociateAddress", "input": { "shape_name": "DisassociateAddressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The elastic IP address that you are disassociating from the instance.\n

\n " }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\t\tAssociation ID corresponding to the VPC elastic IP address you want to disassociate.\n

\n " } }, "documentation": "\n

\n A request to disassociate an elastic IP address from the instance to\n which it is assigned.\n

\n

\n This is an idempotent operation. If you enter it more than once, Amazon\n EC2 will not return an error.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The DisassociateAddress operation disassociates the specified elastic IP\n address from the instance to which it is assigned. This is an idempotent\n operation. If you enter it more than once, Amazon EC2 does not return an error.\n

\n " }, "DisassociateRouteTable": { "name": "DisassociateRouteTable", "input": { "shape_name": "DisassociateRouteTableRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe association ID representing the current association between the route table and subnet.\n\t\t

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tDisassociates a subnet from a route table.\n\t\t

\n\t\t

\n\t\tAfter you perform this action, the subnet no longer uses the routes in the route table. Instead it uses\n\t\tthe routes in the VPC's main route table. For more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n\t\t

\n " }, "EnableVgwRoutePropagation": { "name": "EnableVgwRoutePropagation", "input": { "shape_name": "EnableVgwRoutePropagationRequest", "type": "structure", "members": { "RouteTableId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "EnableVolumeIO": { "name": "EnableVolumeIO", "input": { "shape_name": "EnableVolumeIORequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

\n Enable IO on the volume after an event has occured. \n

\n " }, "GetConsoleOutput": { "name": "GetConsoleOutput", "input": { "shape_name": "GetConsoleOutputRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance for which you want console output.\n

\n ", "required": true } }, "documentation": "\n

\n A request to retrieve the console output for the specified instance.\n

\n

\n Instance console output is buffered and posted shortly after\n instance boot, reboot, and termination.\n Amazon EC2 preserves the most recent 64 KB output which will be available\n for at least one hour after the most recent post.\n

\n " }, "output": { "shape_name": "GetConsoleOutputResult", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose console output was requested.\n

\n ", "xmlname": "instanceId" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time the output was last updated.\n

\n ", "xmlname": "timestamp" }, "Output": { "shape_name": "String", "type": "string", "documentation": "\n

\n The console output, Base64 encoded.\n

\n ", "xmlname": "output" } }, "documentation": "\n

\n The result of the GetConsoleOutput operation.\n

\n " }, "errors": [], "documentation": "\n

\n The GetConsoleOutput operation retrieves console output for the specified\n instance.\n

\n

\n Instance console output is buffered and posted shortly after instance boot,\n reboot, and termination. Amazon EC2 preserves the most recent 64 KB output\n which will be available for at least one hour after the most recent post.\n

\n " }, "GetPasswordData": { "name": "GetPasswordData", "input": { "shape_name": "GetPasswordDataRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance for which you want the Windows administrator\n password.\n

\n ", "required": true } }, "documentation": "\n

\n A request to retrieve the encrypted administrator password for the\n instances running Windows.\n

\n

\n The Windows password is only generated the first time an AMI is launched.\n It is not generated for rebundled AMIs or after the password is\n changed on an instance.\n The password is encrypted using the key pair that you provided.\n

\n " }, "output": { "shape_name": "GetPasswordDataResult", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose Windows administrator password was\n requested.\n

\n ", "xmlname": "instanceId" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time the data was last updated.\n

\n ", "xmlname": "timestamp" }, "PasswordData": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Windows administrator password of the specified instance.\n

\n ", "xmlname": "passwordData" } }, "documentation": "\n

\n The result of the GetPasswordData operation.\n

\n " }, "errors": [], "documentation": "\n

\n Retrieves the encrypted administrator password for the instances running\n Windows.\n

\n\n \n The Windows password is only generated the first time an AMI is\n launched. It is not generated for rebundled AMIs or after\n the password is changed on an instance.\n The password is encrypted using the key pair that you provided.\n \n " }, "ImportInstance": { "name": "ImportInstance", "input": { "shape_name": "ImportInstanceRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "LaunchSpecification": { "shape_name": "ImportInstanceLaunchSpecification", "type": "structure", "members": { "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": null }, "GroupNames": { "shape_name": "SecurityGroupStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupName" }, "documentation": null, "flattened": true }, "AdditionalInfo": { "shape_name": "String", "type": "string", "documentation": null }, "UserData": { "shape_name": "String", "type": "string", "documentation": null }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": null }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n " }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.\n

\n " } }, "documentation": "\n

\n Describes where an Amazon EC2 instance is running within an Amazon EC2 region.\n

\n " }, "Monitoring": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null }, "InstanceInitiatedShutdownBehavior": { "shape_name": "ShutdownBehavior", "type": "string", "enum": [ "stop", "terminate" ], "documentation": null }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "DiskImages": { "shape_name": "DiskImageList", "type": "list", "members": { "shape_name": "DiskImage", "type": "structure", "members": { "Image": { "shape_name": "DiskImageDetail", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true }, "Bytes": { "shape_name": "Long", "type": "long", "documentation": null, "required": true }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "no_paramfile": true } }, "documentation": null }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "Volume": { "shape_name": "VolumeDetail", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true } }, "documentation": null } }, "documentation": null, "xmlname": "DiskImage" }, "documentation": null, "flattened": true }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "ImportInstanceResult", "type": "structure", "members": { "ConversionTask": { "shape_name": "ConversionTask", "type": "structure", "members": { "ConversionTaskId": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "expirationTime" }, "ImportInstance": { "shape_name": "ImportInstanceTaskDetails", "type": "structure", "members": { "Volumes": { "shape_name": "ImportInstanceVolumeDetailSet", "type": "list", "members": { "shape_name": "ImportInstanceVolumeDetailItem", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "required": true, "xmlname": "volumes" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": null, "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" } }, "documentation": null, "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": null, "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "conversionTask" } }, "documentation": null }, "errors": [], "documentation": null }, "ImportKeyPair": { "name": "ImportKeyPair", "input": { "shape_name": "ImportKeyPairRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique name for the key pair.\n

\n ", "required": true }, "PublicKeyMaterial": { "shape_name": "String", "type": "blob", "documentation": "\n

\n The public key portion of the key pair being imported.\n

\n ", "required": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "ImportKeyPairResult", "type": "structure", "members": { "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The specified unique key pair name.\n

\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\n

\n The MD5 public key fingerprint as specified in section 4 of\n \n RFC4716\n .\n

\n ", "xmlname": "keyFingerprint" } }, "documentation": "\n

\n " }, "errors": [], "documentation": "\n

\n Imports the public key from an RSA key pair created with a third-party tool.\n This operation differs from CreateKeyPair as the private key is never\n transferred between the caller and AWS servers.\n

\n

\n RSA key pairs are easily created on Microsoft Windows and Linux OS systems using\n the ssh-keygen command line tool provided with the standard OpenSSH\n installation. Standard library support for RSA key pair creation is also available\n for Java, Ruby, Python, and many other programming languages.\n

\n

The following formats are supported:

\n \n " }, "ImportVolume": { "name": "ImportVolume", "input": { "shape_name": "ImportVolumeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null }, "Image": { "shape_name": "DiskImageDetail", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true }, "Bytes": { "shape_name": "Long", "type": "long", "documentation": null, "required": true }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true } }, "documentation": null }, "Description": { "shape_name": "String", "type": "string", "documentation": null }, "Volume": { "shape_name": "VolumeDetail", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true } }, "documentation": null } }, "documentation": null }, "output": { "shape_name": "ImportVolumeResult", "type": "structure", "members": { "ConversionTask": { "shape_name": "ConversionTask", "type": "structure", "members": { "ConversionTaskId": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "expirationTime" }, "ImportInstance": { "shape_name": "ImportInstanceTaskDetails", "type": "structure", "members": { "Volumes": { "shape_name": "ImportInstanceVolumeDetailSet", "type": "list", "members": { "shape_name": "ImportInstanceVolumeDetailItem", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "required": true, "xmlname": "volumes" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": null, "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" } }, "documentation": null, "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": null, "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": null, "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "checksum" } }, "documentation": null, "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": null, "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "id" } }, "documentation": null, "required": true, "xmlname": "volume" } }, "documentation": null, "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": null, "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "tagSet" } }, "documentation": null, "xmlname": "conversionTask" } }, "documentation": null }, "errors": [], "documentation": null }, "ModifyImageAttribute": { "name": "ModifyImageAttribute", "input": { "shape_name": "ModifyImageAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the AMI whose attribute you want to modify.\n

\n ", "required": true }, "Attribute": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the AMI attribute you want to modify.\n

\n

\n Available attributes: launchPermission, productCodes\n

\n " }, "OperationType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of operation being requested.\n

\n

\n Available operation types: add, remove\n

\n " }, "UserIds": { "shape_name": "UserIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserId" }, "documentation": "\n

\n The AWS user ID being added to or removed from the list of users with\n launch permissions for this AMI.\n Only valid when the launchPermission attribute is being modified.\n

\n ", "flattened": true }, "UserGroups": { "shape_name": "UserGroupStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserGroup" }, "documentation": "\n

\n The user group being added to or removed from the list of user groups\n with launch permissions for this AMI.\n Only valid when the launchPermission attribute is being modified.\n

\n

\n Available user groups: all\n

\n ", "flattened": true }, "ProductCodes": { "shape_name": "ProductCodeStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ProductCode" }, "documentation": "\n

\n The list of product codes being added to or removed from the specified\n AMI.\n Only valid when the productCodes attribute is being modified.\n

\n ", "flattened": true }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The value of the attribute being modified.\n Only valid when the description attribute is being modified.\n

\n " }, "LaunchPermission": { "shape_name": "LaunchPermissionModifications", "type": "structure", "members": { "Add": { "shape_name": "LaunchPermissionList", "type": "list", "members": { "shape_name": "LaunchPermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of the user involved in this launch permission.\n

\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The AWS group of the user involved in this launch permission.\n

\n

\n Available groups: all\n

\n " } }, "documentation": "\n

\n Describes a permission to launch an Amazon Machine Image (AMI).\n

\n " }, "documentation": null, "flattened": true }, "Remove": { "shape_name": "LaunchPermissionList", "type": "list", "members": { "shape_name": "LaunchPermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of the user involved in this launch permission.\n

\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The AWS group of the user involved in this launch permission.\n

\n

\n Available groups: all\n

\n " } }, "documentation": "\n

\n Describes a permission to launch an Amazon Machine Image (AMI).\n

\n " }, "documentation": null, "flattened": true } }, "documentation": null }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" } }, "documentation": "\n

\n A request to modify an attribute of an Amazon Machine Image (AMI).\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The ModifyImageAttribute operation modifies an attribute of an AMI.\n

\n " }, "ModifyInstanceAttribute": { "name": "ModifyInstanceAttribute", "input": { "shape_name": "ModifyInstanceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose attribute is being modified.\n

\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\n

\n The name of the attribute being modified.\n

\n

\n Available attribute names: instanceType, kernel, ramdisk,\n userData, disableApiTermination, instanceInitiatedShutdownBehavior,\n rootDevice, blockDeviceMapping\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new value of the instance attribute being modified.\n

\n

\n Only valid when kernel, ramdisk, userData,\n disableApiTermination or instanceInitiateShutdownBehavior is specified\n as the attribute being modified.\n

\n " }, "BlockDeviceMappings": { "shape_name": "InstanceBlockDeviceMappingSpecificationList", "type": "list", "members": { "shape_name": "InstanceBlockDeviceMappingSpecification", "type": "structure", "members": { "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The device name (e.g., /dev/sdh) at which the block device is exposed on\n the instance.\n

\n " }, "Ebs": { "shape_name": "EbsInstanceBlockDeviceSpecification", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS volume that should be mounted as a block device on an\n Amazon EC2 instance.\n

\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n " } }, "documentation": "\n

\n The EBS instance block device specification describing the EBS block\n device to map to the specified device name on a running\n instance.\n

\n " }, "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The virtual device name.\n

\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n When set to the empty string, specifies that the device name in this\n object should not be mapped to any real device.\n

\n " } }, "documentation": "\n

\n Specifies how an instance's block devices should be mapped on a running\n instance.\n

\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\n

\n The new block device mappings for the instance whose attributes are being\n modified.\n

\n

\n Only valid when blockDeviceMapping is specified as the attribute being\n modified.\n

\n ", "flattened": true }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" }, "DisableApiTermination": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" }, "InstanceType": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" }, "Kernel": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" }, "Ramdisk": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" }, "UserData": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "blob", "documentation": "String value" } }, "documentation": "String value" }, "InstanceInitiatedShutdownBehavior": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" }, "Groups": { "shape_name": "GroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupId" }, "documentation": null, "flattened": true }, "EbsOptimized": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" }, "SriovNetSupport": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" } }, "documentation": "\n

\n A request to modify an attribute of an Amazon EC2 instance. Only one\n attribute can be changed per request.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Modifies an attribute of an instance.\n

\n " }, "ModifyNetworkInterfaceAttribute": { "name": "ModifyNetworkInterfaceAttribute", "input": { "shape_name": "ModifyNetworkInterfaceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": "String value" } }, "documentation": "String value" }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "flattened": true }, "Attachment": { "shape_name": "NetworkInterfaceAttachmentChanges", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "ModifyReservedInstances": { "name": "ModifyReservedInstances", "input": { "shape_name": "ModifyReservedInstancesRequest", "type": "structure", "members": { "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\n

\n A unique, case-sensitive, token you provide to ensure idempotency\n of your modification request.\n

\n " }, "ReservedInstancesIds": { "shape_name": "ReservedInstancesIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReservedInstancesId" }, "documentation": "\n

\n The IDs of the Reserved Instances to modify.\n

\n ", "required": true, "flattened": true }, "TargetConfigurations": { "shape_name": "ReservedInstancesConfigurationList", "type": "list", "members": { "shape_name": "ReservedInstancesConfiguration", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone for the modified Reserved Instances.\n

\n " }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\n

\n The network platform of the modified Reserved Instances, which is either\n EC2-Classic or EC2-VPC.\n

\n " }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of modified Reserved Instances.\n

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type for the modified Reserved Instances.\n

\n " } }, "documentation": "\n

\n The configuration settings for the modified Reserved Instances.\n

\n ", "xmlname": "ReservedInstancesConfigurationSetItemType" }, "documentation": "\n

\n The configuration settings for the Reserved Instances to modify.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n A request to modify the Reserved Instances.\n

\n " }, "output": { "shape_name": "ModifyReservedInstancesResult", "type": "structure", "members": { "ReservedInstancesModificationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID for the submitted modification request.\n

\n ", "xmlname": "reservedInstancesModificationId" } }, "documentation": "\n

\n The result of modifying Reserved Instances. Contains the\n ID of the modification request.\n

\n " }, "errors": [], "documentation": "\n

\n The ModifyReservedInstances operation modifies the Availability Zone,\n instance count, instance type, or network platform (EC2-Classic or EC2-VPC)\n of your Reserved Instances.\n

\n " }, "ModifySnapshotAttribute": { "name": "ModifySnapshotAttribute", "input": { "shape_name": "ModifySnapshotAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS snapshot whose attributes are being modified.\n

\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\n

\n The name of the attribute being modified.\n

\n

\n Available attribute names: createVolumePermission\n

\n " }, "OperationType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The operation to perform on the attribute.\n

\n

\n Available operation names: add, remove\n

\n " }, "UserIds": { "shape_name": "UserIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserId" }, "documentation": "\n

\n The AWS user IDs to add to or remove from the list of users that have\n permission\n to create EBS volumes from the specified snapshot. Currently supports\n \"all\".\n

\n \n Only valid when the createVolumePermission attribute is being modified.\n \n ", "flattened": true }, "GroupNames": { "shape_name": "GroupNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserGroup" }, "documentation": "\n

\n The AWS group names to add to or remove from the list of groups that have\n permission\n to create EBS volumes from the specified snapshot. Currently supports\n \"all\".\n

\n \n Only valid when the createVolumePermission attribute is being modified.\n \n ", "flattened": true }, "CreateVolumePermission": { "shape_name": "CreateVolumePermissionModifications", "type": "structure", "members": { "Add": { "shape_name": "CreateVolumePermissionList", "type": "list", "members": { "shape_name": "CreateVolumePermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The user ID of the user that can create volumes from the snapshot.\n

\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The group that is allowed to create volumes from the snapshot (currently\n supports \"all\").\n

\n " } }, "documentation": "\n

\n Describes a permission allowing either a user or group to create a new EBS\n volume from a snapshot.\n

\n " }, "documentation": null, "flattened": true }, "Remove": { "shape_name": "CreateVolumePermissionList", "type": "list", "members": { "shape_name": "CreateVolumePermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The user ID of the user that can create volumes from the snapshot.\n

\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\n

\n The group that is allowed to create volumes from the snapshot (currently\n supports \"all\").\n

\n " } }, "documentation": "\n

\n Describes a permission allowing either a user or group to create a new EBS\n volume from a snapshot.\n

\n " }, "documentation": null, "flattened": true } }, "documentation": null } }, "documentation": "\n

\n A request to modify an EBS snapshot's attributes. Only one attribute\n can be changed per request.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Adds or remove permission settings for the specified snapshot.\n

\n " }, "ModifyVolumeAttribute": { "name": "ModifyVolumeAttribute", "input": { "shape_name": "ModifyVolumeAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "AutoEnableIO": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "ModifyVpcAttribute": { "name": "ModifyVpcAttribute", "input": { "shape_name": "ModifyVpcAttributeRequest", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "EnableDnsSupport": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" }, "EnableDnsHostnames": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": "Boolean value" } }, "documentation": "Boolean value" } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "MonitorInstances": { "name": "MonitorInstances", "input": { "shape_name": "MonitorInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of Amazon EC2 instances on which to enable monitoring.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n A request to enable monitoring for a running instance.\n

\n " }, "output": { "shape_name": "MonitorInstancesResult", "type": "structure", "members": { "InstanceMonitorings": { "shape_name": "InstanceMonitoringList", "type": "list", "members": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Instance ID.\n

\n ", "xmlname": "instanceId" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\n

\n The state of monitoring on an Amazon EC2 instance (ex: enabled,\n disabled).\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n Monitoring state for the associated instance.\n

\n ", "xmlname": "monitoring" } }, "documentation": "\n

\n Represents the monitoring state of an EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of updated monitoring information for the instances specified in\n the request.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The result of enabling monitoring on a set of Amazon EC2 instances.\n Contains the updated monitoring status for each instance\n specified in the request.\n

\n " }, "errors": [], "documentation": "\n

\n Enables monitoring for a running instance.\n

\n " }, "PurchaseReservedInstancesOffering": { "name": "PurchaseReservedInstancesOffering", "input": { "shape_name": "PurchaseReservedInstancesOfferingRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ReservedInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the Reserved Instances offering being purchased.\n

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of Reserved Instances to purchase.\n

\n ", "required": true }, "LimitPrice": { "shape_name": "ReservedInstanceLimitPrice", "type": "structure", "members": { "Amount": { "shape_name": "Double", "type": "double", "documentation": null }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": null } }, "documentation": null } }, "documentation": "\n

\n Purchases a Reserved Instance for use with your account.\n

\n

\n With Amazon EC2\n Reserved Instances, you purchase\n the right to launch Amazon EC2 instances for a period of time (without\n getting insufficient capacity errors)\n and pay a lower usage rate for the actual time used.\n

\n " }, "output": { "shape_name": "PurchaseReservedInstancesOfferingResult", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the Reserved Instances purchased for your account.\n

\n ", "xmlname": "reservedInstancesId" } }, "documentation": "\n

\n The result of purchasing a Reserved Instances offering.\n Contains the new, unique ID of the Reserved Instances purchased for your\n account.\n

\n " }, "errors": [], "documentation": "\n

\n The PurchaseReservedInstancesOffering operation purchases a\n Reserved Instance for use with your account. With Amazon EC2\n Reserved Instances, you purchase the right to launch Amazon EC2\n instances for a period of time (without getting insufficient\n capacity errors) and pay a lower usage rate for the\n actual time used.\n

\n " }, "RebootInstances": { "name": "RebootInstances", "input": { "shape_name": "RebootInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of instances to terminate.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n A request to reboot one or more instances.\n

\n

\n This operation is asynchronous; it only queues a request to reboot the\n specified instances.\n The operation will succeed if the instances are valid and belong to you.\n Requests to reboot terminated instances are ignored.\n

\n \n If a Linux/UNIX instance does not cleanly shut down within four\n minutes, Amazon EC2 will perform a hard reboot.\n \n " }, "output": null, "errors": [], "documentation": "\n

\n The RebootInstances operation requests a reboot of one or more instances. This\n operation is asynchronous; it only queues a request to reboot the specified\n instance(s). The operation will succeed if the instances are valid and belong\n to the user. Requests to reboot terminated instances are ignored.\n

\n " }, "RegisterImage": { "name": "RegisterImage", "input": { "shape_name": "RegisterImageRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageLocation": { "shape_name": "String", "type": "string", "documentation": "\n The full path to your AMI manifest in Amazon S3 storage.\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name to give the new Amazon Machine Image.\n

\n

\n Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes\n (/), dashes (-), or underscores(_)\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n The description describing the new AMI.\n " }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\n The architecture of the image.\n

\n Valid Values: i386, x86_64\n

\n " }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n The optional ID of a specific kernel to register with the new AMI.\n " }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The optional ID of a specific ramdisk to register with the new AMI.\n

\n

\n Some kernels require additional drivers at launch. Check the kernel\n requirements for information on whether you need to specify a\n RAM disk.\n

\n " }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The root device name (e.g., /dev/sda1).\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingRequestList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n " }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\n

\n The block device mappings for the new AMI, which specify how different\n block devices (ex: EBS volumes and ephemeral drives) will be\n exposed on instances launched from the new image.\n

\n ", "flattened": true }, "VirtualizationType": { "shape_name": "String", "type": "string", "documentation": "The type of virtualization", "enum": [ "paravirtual", "hvm" ] }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": "\n

\n A request to register an AMI with Amazon EC2. Images must be registered\n before they can be launched.\n To launch instances, use the RunInstances operation.\n

\n

\n Each AMI is associated with an unique ID which is provided by the Amazon\n EC2 service through this operation.\n If needed, you can deregister an AMI at any time.\n

\n \n

\n AMIs backed by Amazon EBS are automatically registered when you\n create the image.\n However, you can use this to register a snapshot of an instance backed by\n Amazon EBS.\n Amazon EBS snapshots are not guaranteed to be bootable. For information on\n creating AMIs backed by Amazon EBS,\n go to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic\n Compute Cloud User Guide.\n

\n \n

\n Any modifications to an AMI backed by Amazon S3 invalidates this\n registration.\n If you make changes to an image, deregister the previous image and\n register the new image.\n

\n " }, "output": { "shape_name": "RegisterImageResult", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the new Amazon Machine Image (AMI).\n

\n ", "xmlname": "imageId" } }, "documentation": "\n

\n The result of registering a new Amazon Machine Image (AMI). Contains the\n ID of the new image.\n

\n " }, "errors": [], "documentation": "\n

\n The RegisterImage operation registers an AMI with Amazon EC2. Images must be\n registered before they can be launched. For more information, see RunInstances.\n

\n

\n Each AMI is associated with an unique ID which is provided by the Amazon EC2\n service through the RegisterImage operation. During registration, Amazon EC2\n retrieves the specified image manifest from Amazon S3 and verifies that the\n image is owned by the user registering the image.\n

\n

\n The image manifest is retrieved once and stored within the Amazon EC2. Any\n modifications to an image in Amazon S3 invalidates this registration. If you\n make changes to an image, deregister the previous image and register the new\n image. For more information, see DeregisterImage.\n

\n " }, "ReleaseAddress": { "name": "ReleaseAddress", "input": { "shape_name": "ReleaseAddressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The elastic IP address that you are releasing from your account.\n

\n " }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allocation ID that AWS provided when you allocated the address for use with Amazon VPC.\n

\n " } }, "documentation": "\n

\n A request to release an elastic IP address associated with your\n account.\n

\n

\n If you run this operation on an elastic IP address that is already\n released,\n the address might be assigned to another account which will cause Amazon\n EC2 to return an error.\n

\n \n Releasing an IP address automatically disassociates it from any\n instance with which it is associated.\n To disassociate an IP address without releasing it, use the\n DisassociateAddress operation.\n \n \n Important: After releasing an elastic IP address, it is released to the IP\n address pool and might no longer\n be available to your account. Make sure to update your DNS records and\n any servers or devices that communicate with the address.\n \n " }, "output": null, "errors": [], "documentation": "\n

\n The ReleaseAddress operation releases an elastic IP address associated with\n your account.\n

\n \n Releasing an IP address automatically disassociates it from any instance with\n which it is associated. For more information, see DisassociateAddress.\n \n \n

\n After releasing an elastic IP address, it is released to the IP address pool\n and might no longer be available to your account. Make sure to update your DNS\n records and any servers or devices that communicate with the address.\n

\n

\n If you run this operation on an elastic IP address that is already released,\n the address might be assigned to another account which will cause Amazon EC2 to\n return an error.\n

\n \n " }, "ReplaceNetworkAclAssociation": { "name": "ReplaceNetworkAclAssociation", "input": { "shape_name": "ReplaceNetworkAclAssociationRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID representing the current association between the original network ACL and the subnet.\n\t\t

\n ", "required": true }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of the new ACL to associate with the subnet.\n\t\t

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ReplaceNetworkAclAssociationResult", "type": "structure", "members": { "NewAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "newAssociationId" } }, "documentation": null }, "errors": [], "documentation": "\n\t\t

\n\t\tChanges which network ACL a subnet is associated with. By default when you create a subnet, it's\n\t\tautomatically associated with the default network ACL. For more information about network ACLs, go to\n\t\tNetwork ACLs in the Amazon Virtual Private Cloud User Guide.\n\t\t

\n " }, "ReplaceNetworkAclEntry": { "name": "ReplaceNetworkAclEntry", "input": { "shape_name": "ReplaceNetworkAclEntryRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tID of the ACL where the entry will be replaced.\n\t\t

\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\t

\n\t\tRule number of the entry to replace.\n\t\t

\n ", "required": true }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tIP protocol the rule applies to. Valid Values: tcp, udp,\n\t\ticmp or an IP protocol number.\n\t\t

\n ", "required": true }, "RuleAction": { "shape_name": "RuleAction", "type": "string", "enum": [ "allow", "deny" ], "documentation": "\n\t\t

\n\t\tWhether to allow or deny traffic that matches the rule.\n\t\t

\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\t

\n\t\tWhether this rule applies to egress traffic from the subnet (true) or\n\t\tingress traffic (false).\n\t\t

\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe CIDR range to allow or deny, in CIDR notation (e.g., 172.16.0.0/24).\n\t\t

\n ", "required": true }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP type. A value of -1 is a wildcard meaning all types. Required if specifying icmp for the protocol.\n

\n " }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n For the ICMP protocol, the ICMP code. A value of -1 is a wildcard meaning all codes. Required if specifying icmp for the protocol.\n

\n " } }, "documentation": "\n \t

ICMP values.

\n ", "xmlname": "Icmp" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe first port in the range. Required if specifying tcp or udp for the protocol.\n

\n " }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n \tThe last port in the range. Required if specifying tcp or udp for the protocol.\n

\n " } }, "documentation": "\n\t\t

Port ranges.

\n " } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tReplaces an entry (i.e., rule) in a network ACL. For more information about network ACLs, go to\n\t\tNetwork ACLs in the Amazon Virtual Private Cloud User Guide.\n\t\t

\n " }, "ReplaceRoute": { "name": "ReplaceRoute", "input": { "shape_name": "ReplaceRouteRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of the route table where the route will be replaced.\n\t\t

\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe CIDR address block used for the destination match. For example: 0.0.0.0/0. The value you\n\t\tprovide must match the CIDR of an existing route in the table.\n\t\t

\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of a VPN or Internet gateway attached to your VPC.\n\t\t

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of a NAT instance in your VPC.\n\t\t

\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tReplaces an existing route within a route table in a VPC. For more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n\t\t

\n " }, "ReplaceRouteTableAssociation": { "name": "ReplaceRouteTableAssociation", "input": { "shape_name": "ReplaceRouteTableAssociationRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID representing the current association between the original route table and the subnet.\n\t\t

\n ", "required": true }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tThe ID of the new route table to associate with the subnet.\n\t\t

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ReplaceRouteTableAssociationResult", "type": "structure", "members": { "NewAssociationId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "newAssociationId" } }, "documentation": null }, "errors": [], "documentation": "\n\t\t

\n\t\tChanges the route table associated with a given subnet in a VPC. After you execute this action, the subnet\n\t\tuses the routes in the new route table it's associated with. For more information about route tables, go to\n\t\tRoute Tables\n\t\tin the Amazon Virtual Private Cloud User Guide.\n\t\t

\n\t\t

\n\t\tYou can also use this to change which table is the main route table in the VPC. You just specify the main\n\t\troute table's association ID and the route table that you want to be the new main route table.\n\t\t

\n " }, "ReportInstanceStatus": { "name": "ReportInstanceStatus", "input": { "shape_name": "ReportInstanceStatusRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "Instances": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": null, "flattened": true }, "Status": { "shape_name": "ReportStatusType", "type": "string", "enum": [ "ok", "impaired" ], "documentation": null }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null }, "EndTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null }, "ReasonCodes": { "shape_name": "ReasonCodesList", "type": "list", "members": { "shape_name": "ReportInstanceReasonCodes", "type": "string", "enum": [ "instance-stuck-in-state", "unresponsive", "not-accepting-credentials", "password-not-available", "performance-network", "performance-instance-store", "performance-ebs-volume", "performance-other", "other" ], "documentation": null, "xmlname": "ReasonCode" }, "documentation": null, "flattened": true }, "Description": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "RequestSpotInstances": { "name": "RequestSpotInstances", "input": { "shape_name": "RequestSpotInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the maximum hourly price for any Spot Instance\n launched to fulfill the request.\n

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the maximum number of Spot Instances to launch.\n

\n " }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": "\n

\n Specifies the Spot Instance type.\n

\n " }, "ValidFrom": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n Defines the start date of the request.\n

\n

\n If this is a one-time request,\n the request becomes active at this date and time and remains\n active until all instances launch, the request expires, or the\n request is canceled. If the request is persistent, the request\n becomes active at this date and time and remains active until\n it expires or is canceled.\n

\n " }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n End date of the request.\n

\n

\n If this is a one-time request, the request remains active\n until all instances launch, the request is canceled, or\n this date is reached. If the request is persistent, it\n remains active until it is canceled or this date and time\n is reached.\n

\n " }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the instance launch group. Launch groups are\n Spot Instances that launch and terminate together.\n

\n " }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Availability Zone group.\n

\n

\n When specifying the same Availability Zone group for all\n Spot Instance requests, all Spot Instances are launched\n in the same Availability Zone.\n

\n " }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AMI ID.\n

\n " }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n " }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\n

\n Optional data, specific to a user's application, to provide in the launch request.\n All instances that collectively comprise the launch request have access to this data.\n User data is never returned through API responses.\n

\n " }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Deprecated.\n

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n Specifies the instance type.\n

\n " }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n " } }, "documentation": "\n

\n Defines a placement item.\n

\n " }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the kernel to select.\n

\n " }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the RAM disk to select.\n Some kernels require additional drivers at launch.\n Check the kernel requirements for information on whether\n or not you need to specify a RAM disk and search for the kernel ID.\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n " }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n

\n ", "flattened": true }, "Monitoring": { "type": "structure", "members": { "Enabled": { "shape_name": "Boolean", "type": "boolean", "required": true, "documentation": "\n

\n Enables monitoring for the instance.\n

\n " } } }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC subnet ID within which to launch the instance(s)\n for Amazon Virtual Private Cloud.\n

\n " }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceSpecificationList", "type": "list", "members": { "shape_name": "InstanceNetworkInterfaceSpecification", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n

An existing interface to attach to a single instance. Requires n=1\n instances.

\n " }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The device index. Applies to both attaching an existing network interface and when\n creating a network interface.

\n

Condition: If you are specifying a network interface in the\n request, you must provide the device index.

\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The subnet ID. Applies only when creating a network interface.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description. Applies only when creating a network interface.

\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The primary private IP address. \n Applies only when creating a network interface. \n Requires n=1 network interfaces in launch.

\n

\n " }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "flattened": true }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressSpecificationList", "type": "list", "members": { "shape_name": "PrivateIpAddressSpecification", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null }, "documentation": null, "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether to assign a public IP address to an instance in a VPC. The public IP\n address is associated with a specific network interface. If set to true,\n the following rules apply:\n

\n
    \n
  1. \n

    Can only be associated with a single network interface with\n the device index of 0. You can't associate a public IP address\n with a second network interface, and you can't associate a\n public IP address if you are launching more than one network\n interface.

    \n
    2. \n
  2. \n

    Can only be associated with a new network interface, \n not an existing one.

    \n
    3. \n
\n

\n Default: If launching into a default subnet, the default value is true.\n If launching into a nondefault subnet, the default value is\n false. \n

\n " } }, "documentation": null, "xmlname": "NetworkInterface" }, "documentation": null, "flattened": true }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null }, "Name": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SecurityGroupIds": { "type": "list", "members": { "type": "string", "xmlname": "SecurityGroupId" }, "flattened": true }, "SecurityGroups": { "type": "list", "members": { "type": "string", "xmlname": "SecurityGroup" }, "flattened": true } }, "documentation": "\n

\n Specifies additional launch instance information.\n

\n " } }, "documentation": "\n

\n The RequestSpotInstances data type.\n

\n " }, "output": { "shape_name": "RequestSpotInstancesResult", "type": "structure", "members": { "SpotInstanceRequests": { "shape_name": "SpotInstanceRequestList", "type": "list", "members": { "shape_name": "SpotInstanceRequest", "type": "structure", "members": { "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotInstanceRequestId" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "spotPrice" }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": null, "xmlname": "type" }, "State": { "shape_name": "SpotInstanceState", "type": "string", "enum": [ "open", "active", "closed", "cancelled", "failed" ], "documentation": null, "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": null, "xmlname": "fault" }, "Status": { "shape_name": "SpotInstanceStatus", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "code" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "updateTime" }, "Message": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "message" } }, "documentation": null, "xmlname": "status" }, "ValidFrom": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "validFrom" }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "validUntil" }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "launchGroup" }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "availabilityZoneGroup" }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AMI ID.\n

\n ", "xmlname": "imageId" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n ", "xmlname": "keyName" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\n

\n Optional data, specific to a user's application, to provide in the launch request.\n All instances that collectively comprise the launch request have access to this data.\n User data is never returned through API responses.\n

\n ", "xmlname": "userData" }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Deprecated.\n

\n ", "xmlname": "addressingType" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n Specifies the instance type.\n

\n ", "xmlname": "instanceType" }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n ", "xmlname": "groupName" } }, "documentation": "\n

\n Defines a placement item.\n

\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the kernel to select.\n

\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the ID of the RAM disk to select.\n Some kernels require additional drivers at launch.\n Check the kernel requirements for information on whether\n or not you need to specify a RAM disk and search for the kernel ID.\n

\n ", "xmlname": "ramdiskId" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null, "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "iops" } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n ", "xmlname": "noDevice" } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n

\n ", "xmlname": "blockDeviceMapping" }, "MonitoringEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Enables monitoring for the instance.\n

\n ", "xmlname": "monitoringEnabled" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC subnet ID within which to launch the instance(s)\n for Amazon Virtual Private Cloud.\n

\n ", "xmlname": "subnetId" }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceSpecificationList", "type": "list", "members": { "shape_name": "InstanceNetworkInterfaceSpecification", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n

An existing interface to attach to a single instance. Requires n=1\n instances.

\n ", "xmlname": "networkInterfaceId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The device index. Applies to both attaching an existing network interface and when\n creating a network interface.

\n

Condition: If you are specifying a network interface in the\n request, you must provide the device index.

\n ", "xmlname": "deviceIndex" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The subnet ID. Applies only when creating a network interface.

\n ", "xmlname": "subnetId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description. Applies only when creating a network interface.

\n ", "xmlname": "description" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The primary private IP address. \n Applies only when creating a network interface. \n Requires n=1 network interfaces in launch.

\n

\n ", "xmlname": "privateIpAddress" }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "xmlname": "SecurityGroupId" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressSpecificationList", "type": "list", "members": { "shape_name": "PrivateIpAddressSpecification", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "required": true, "xmlname": "privateIpAddress" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether to assign a public IP address to an instance in a VPC. The public IP\n address is associated with a specific network interface. If set to true,\n the following rules apply:\n

\n
    \n
  1. \n

    Can only be associated with a single network interface with\n the device index of 0. You can't associate a public IP address\n with a second network interface, and you can't associate a\n public IP address if you are launching more than one network\n interface.

    \n
    2. \n
  2. \n

    Can only be associated with a new network interface, \n not an existing one.

    \n
    3. \n
\n

\n Default: If launching into a default subnet, the default value is true.\n If launching into a nondefault subnet, the default value is\n false. \n

\n ", "xmlname": "associatePublicIpAddress" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "arn" }, "Name": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "name" } }, "documentation": null, "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "ebsOptimized" } }, "documentation": "\n

\n The LaunchSpecificationType data type.\n

\n ", "xmlname": "launchSpecification" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "instanceId" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "createTime" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": null, "xmlname": "productDescription" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for this spot instance request.\n

\n ", "xmlname": "tagSet" }, "LaunchedAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the bid is launched.\n

\n ", "xmlname": "launchedAvailabilityZone" } }, "documentation": null, "xmlname": "item" }, "documentation": "\n

\n Contains a list of Spot Instance requests.\n

\n ", "xmlname": "spotInstanceRequestSet" } }, "documentation": "\n

\n The RequestSpotInstancesResult data type.\n

\n " }, "errors": [], "documentation": "\n

\n Creates a Spot Instance request.\n

\n

\n Spot Instances are instances that Amazon EC2 starts on\n your behalf when the maximum price that you specify\n exceeds the current Spot Price. Amazon EC2 periodically\n sets the Spot Price based on available Spot Instance capacity\n and current spot instance requests.\n

\n

\n For conceptual information\n about Spot Instances, refer to the\n \n Amazon Elastic Compute Cloud Developer Guide\n \n or\n \n Amazon Elastic Compute Cloud User Guide.\n \n

\n " }, "ResetImageAttribute": { "name": "ResetImageAttribute", "input": { "shape_name": "ResetImageAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the AMI whose attribute is being reset.\n

\n ", "required": true }, "Attribute": { "shape_name": "ResetImageAttributeName", "type": "string", "enum": [ "launchPermission" ], "documentation": "\n

\n The name of the attribute being reset.\n

\n

\n Available attribute names: launchPermission\n

\n ", "required": true } }, "documentation": "\n

\n A request to reset an attribute on an Amazon Machine Image (AMI) back\n to its default value.\n Only one attribute can be reset per request.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The ResetImageAttribute operation resets an attribute of an AMI to its default\n value.\n

\n \n The productCodes attribute cannot be reset.\n \n " }, "ResetInstanceAttribute": { "name": "ResetInstanceAttribute", "input": { "shape_name": "ResetInstanceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Amazon EC2 instance whose attribute is being reset.\n

\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\n

\n The name of the attribute being reset.\n

\n

\n Available attribute names: kernel, ramdisk\n

\n ", "required": true } }, "documentation": "\n

\n A request to reset an attribute on an Amazon EC2 instance back to its\n default value.\n Only one attribute can be reset per request.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Resets an attribute of an instance to its default value.\n

\n " }, "ResetNetworkInterfaceAttribute": { "name": "ResetNetworkInterfaceAttribute", "input": { "shape_name": "ResetNetworkInterfaceAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "SourceDestCheck": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "ResetSnapshotAttribute": { "name": "ResetSnapshotAttribute", "input": { "shape_name": "ResetSnapshotAttributeRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot whose attribute is being reset.\n

\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\n

\n The name of the attribute being reset.\n

\n

\n Available attribute names: createVolumePermission\n

\n ", "required": true } }, "documentation": "\n

\n A request to reset an attribute on a snapshot back to its default\n value.\n Only one attribute can be reset per request.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Resets permission settings for the specified snapshot.\n

\n " }, "RevokeSecurityGroupEgress": { "name": "RevokeSecurityGroupEgress", "input": { "shape_name": "RevokeSecurityGroupEgressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the VPC security group to modify.\n

\n ", "required": true }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n " }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n " }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n " }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "Groups" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "flattened": true }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n " } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n " }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "flattened": true } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n " }, "documentation": "\n

\n List of IP permissions to authorize on the specified security group. Specifying\n permissions through IP permissions is the preferred way of authorizing permissions\n since it offers more flexibility and control.\n

\n ", "flattened": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n\t\t

\n\t\tThis action applies only to security groups in a VPC. It doesn't work with EC2 security groups. For\n\t\tinformation about Amazon Virtual Private Cloud and VPC security groups, go to the Amazon Virtual\n\t\tPrivate Cloud User Guide.\n\t\t

\n\t\t

\n\t\tThe action removes one or more egress rules from a VPC security group. The values that you specify in\n\t\tthe revoke request (e.g., ports, etc.) must match the existing rule's values in order for the rule to\n\t\tbe revoked.\n\t\t

\n\t\t

\n\t\tEach rule consists of the protocol, and the CIDR range or destination security group. For the TCP and\n\t\tUDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol,\n\t\tyou must also specify the ICMP type and code.\n\t\t

\n\t\t

\n\t\tRule changes are propagated to instances within the security group as quickly as possible. However, a\n\t\tsmall delay might occur.\n\t\t

\n " }, "RevokeSecurityGroupIngress": { "name": "RevokeSecurityGroupIngress", "input": { "shape_name": "RevokeSecurityGroupIngressRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.\n

\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP protocol of this permission.\n

\n

\n Valid protocol values: tcp, udp, icmp\n

\n " }, "FromPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Start of port range for the TCP and UDP protocols, or an ICMP type number.\n An ICMP type number of -1 indicates a wildcard (i.e., any ICMP\n type number).\n

\n " }, "ToPort": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP\n code of -1 indicates a wildcard (i.e., any ICMP code).\n

\n " }, "UserIdGroupPairs": { "shape_name": "UserIdGroupPairList", "type": "list", "members": { "shape_name": "UserIdGroupPair", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS user ID of an account.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n ID of the security group in the specified AWS account. Cannot be used when specifying a CIDR IP address range.\n

\n " } }, "documentation": "\n

\n An AWS user ID identifying an AWS account, and the name of a security\n group within that account.\n

\n ", "xmlname": "Groups" }, "documentation": "\n

\n The list of AWS user IDs and groups included in this permission.\n

\n ", "flattened": true }, "IpRanges": { "shape_name": "IpRangeList", "type": "list", "members": { "shape_name": "IpRange", "type": "structure", "members": { "CidrIp": { "shape_name": "String", "type": "string", "documentation": "\n

\n The list of CIDR IP ranges.\n

\n " } }, "documentation": "\n

\n Contains a list of CIDR IP ranges.\n

\n " }, "documentation": "\n

\n The list of CIDR IP ranges included in this permission.\n

\n ", "flattened": true } }, "documentation": "\n

\n An IP permission describing allowed incoming IP traffic to an Amazon EC2\n security group.\n

\n " }, "documentation": "\n

\n List of IP permissions to revoke on the specified security group. For an IP permission\n to be removed, it must exactly match one of the IP permissions you specify\n in this list. Specifying permissions through IP permissions is the preferred way of\n revoking permissions since it offers more flexibility and control.\n

\n ", "flattened": true } }, "documentation": "\n

\n A request to revoke permissions from a security group.\n The permissions used to revoke must be specified using the same values\n used to grant the permissions.\n

\n

\n Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the\n request (by IP range or an Amazon EC2 user-group pair),\n the source and destination port ranges (for TCP and UDP), and the ICMP\n codes and types (for ICMP).\n

\n

\n Permission changes are quickly propagated to instances within the security\n group.\n However, depending on the number of instances in the group, a small delay\n might occur.\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n The RevokeSecurityGroupIngress operation revokes permissions from a security\n group. The permissions used to revoke must be specified using the same values\n used to grant the permissions.\n

\n

\n Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the\n request (by IP range or an Amazon EC2 user-group pair), the source and\n destination port ranges (for TCP and UDP), and the ICMP codes and types (for\n ICMP).\n

\n

\n Permission changes are quickly propagated to instances within the security\n group. However, depending on the number of instances in the group, a small\n delay might occur.\n

\n " }, "RunInstances": { "name": "RunInstances", "input": { "shape_name": "RunInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique ID of a machine image, returned by a call to DescribeImages.\n

\n ", "required": true }, "MinCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Minimum number of instances to launch. If the value is more than Amazon EC2 can\n launch, no instances are launched at all.\n

\n ", "required": true }, "MaxCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Maximum number of instances to launch. If the value is more than Amazon EC2 can\n launch, the largest possible number above minCount will be launched instead.\n

\n

\n Between 1 and the maximum number allowed for your account (default: 20).\n

\n ", "required": true }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the key pair.\n

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroup" }, "documentation": "\n

\n The names of the security groups into which the instances will be launched.\n

\n ", "flattened": true }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "flattened": true }, "UserData": { "shape_name": "String", "type": "blob", "documentation": "\n

\n Specifies additional information to make available to the instance(s).\n This parameter must be passed as a Base64-encoded string.\n

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n Specifies the instance type for the launched instances.\n

\n " }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n " }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.\n

\n " } }, "documentation": "\n

\n Specifies the placement constraints (Availability Zones) for launching the instances.\n

\n " }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the kernel with which to launch the instance.\n

\n " }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the RAM disk with which to launch the instance. Some kernels require\n additional drivers at launch. Check the kernel requirements for information on\n whether you need to specify a RAM disk. To find kernel requirements, go to the\n Resource Center and search for the kernel ID.\n

\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingRequestList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the virtual device name.\n

\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name (e.g., /dev/sdh).\n

\n " }, "Ebs": { "shape_name": "EbsBlockDevice", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the snapshot from which the volume will be created.\n

\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The size of the volume, in gigabytes.\n

\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": null }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": null } }, "documentation": "\n

\n Specifies parameters used to automatically setup\n Amazon EBS volumes when the instance is launched.\n

\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the device name to suppress during instance launch.\n

\n " } }, "documentation": "\n

\n The BlockDeviceMappingItemType data type.\n

\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\n

\n Specifies how block devices are exposed to the instance.\n Each mapping is made up of a virtualName and a deviceName.\n

\n ", "flattened": true }, "Monitoring": { "shape_name": "RunInstancesMonitoringEnabled", "type": "structure", "members": { "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "required": true } }, "documentation": "\n

\n Enables monitoring for the instance.\n

\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the subnet ID within which to launch the instance(s) for Amazon Virtual\n Private Cloud.\n

\n " }, "DisableApiTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the instance can be terminated using the APIs.\n You must modify this attribute before you can terminate any \"locked\"\n instances from the APIs.\n

\n " }, "InstanceInitiatedShutdownBehavior": { "shape_name": "ShutdownBehavior", "type": "string", "enum": [ "stop", "terminate" ], "documentation": "\n

\n Specifies whether the instance's Amazon EBS volumes are stopped or terminated\n when the instance is shut down.\n

\n " }, "License": { "shape_name": "InstanceLicenseSpecification", "type": "structure", "members": { "Pool": { "shape_name": "String", "type": "string", "documentation": "\n

\n The license pool from which to take a license when starting\n Amazon EC2 instances in the associated RunInstances request.\n

\n " } }, "documentation": "\n

\n Specifies active licenses in use and attached to an Amazon EC2 instance.\n

\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n If you're using Amazon Virtual Private Cloud, you can optionally use this\n parameter to assign the instance a specific available IP address from the subnet.\n

\n " }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n\t\tUnique, case-sensitive identifier you provide to ensure\n\t\tidempotency of the request. For more information,\n\t\tgo to How to Ensure Idempotency in the\n\t\tAmazon Elastic Compute Cloud User Guide.\n\t\t

\n\t" }, "AdditionalInfo": { "shape_name": "String", "type": "string", "documentation": "\n\t\t

\n Do not use. Reserved for internal use.\n\t\t

\n\t" }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceSpecificationList", "type": "list", "members": { "shape_name": "InstanceNetworkInterfaceSpecification", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n

An existing interface to attach to a single instance. Requires n=1\n instances.

\n " }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The device index. Applies to both attaching an existing network interface and when\n creating a network interface.

\n

Condition: If you are specifying a network interface in the\n request, you must provide the device index.

\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The subnet ID. Applies only when creating a network interface.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description. Applies only when creating a network interface.

\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The primary private IP address. \n Applies only when creating a network interface. \n Requires n=1 network interfaces in launch.

\n

\n " }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": null, "flattened": true }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressSpecificationList", "type": "list", "members": { "shape_name": "PrivateIpAddressSpecification", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": null, "xmlname": "PrivateIpAddresses" }, "documentation": null, "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": null }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether to assign a public IP address to an instance in a VPC. The public IP\n address is associated with a specific network interface. If set to true,\n the following rules apply:\n

\n
    \n
  1. \n

    Can only be associated with a single network interface with\n the device index of 0. You can't associate a public IP address\n with a second network interface, and you can't associate a\n public IP address if you are launching more than one network\n interface.

    \n
    2. \n
  2. \n

    Can only be associated with a new network interface, \n not an existing one.

    \n
    3. \n
\n

\n Default: If launching into a default subnet, the default value is true.\n If launching into a nondefault subnet, the default value is\n false. \n

\n " } }, "documentation": null, "xmlname": "NetworkInterface" }, "documentation": "\n

\n List of network interfaces associated with the instance.\n

\n ", "flattened": true }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null }, "Name": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": "\n

\n Launches a specified number of instances of an AMI for which you have\n permissions.\n

\n

\n If Amazon EC2 cannot launch the minimum number AMIs you request, no\n instances will be launched.\n If there is insufficient capacity to launch the maximum number of AMIs\n you request, Amazon EC2 launches the minimum number specified\n for each AMI and allocate the remaining available instances\n using round robin.\n

\n

\n You can provide an optional key pair ID for each image in the launch\n request (created using the CreateKeyPair operation).\n All instances that are created from images that use this key pair will\n have access to the associated public key at boot.\n You can use this key to provide secure access to an instance of an image\n on a per-instance basis.\n Amazon EC2 public images use this feature to provide secure access without\n passwords.\n

\n

\n Important: Launching public images without a key pair ID will leave them\n inaccessible.\n

\n

\n We strongly recommend using the 2.6.18 Xen stock kernel with High-CPU\n and High-Memory instances.\n Although the default Amazon EC2 kernels will work, the new kernels provide\n greater stability and performance for these instance types.\n

\n " }, "output": { "shape_name": "Reservation", "type": "structure", "members": { "ReservationId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of this reservation.\n

\n ", "xmlname": "reservationId" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS Access Key ID of the user who owns the reservation.\n

\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of the user who requested the instances in this\n reservation.\n

\n ", "xmlname": "requesterId" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of security groups requested for the instances in this\n reservation.\n

\n ", "xmlname": "groupSet" }, "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Unique ID of the instance launched.\n

\n ", "xmlname": "instanceId" }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Image ID of the AMI used to launch the instance.\n

\n ", "xmlname": "imageId" }, "State": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "instanceState" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The private DNS name assigned to the instance. This DNS name can only be used inside the\n Amazon EC2 network. This element remains empty until the instance enters a running state.\n

\n ", "xmlname": "privateDnsName" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The public DNS name assigned to the instance. This DNS name is contactable from outside\n the Amazon EC2 network. This element remains empty until the instance enters a running state.\n

\n ", "xmlname": "dnsName" }, "StateTransitionReason": { "shape_name": "String", "type": "string", "documentation": "\n

\n Reason for the most recent state transition. This might be an empty string.\n

\n ", "xmlname": "reason" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If this instance was launched with an associated key pair, this displays the key pair name.\n

\n ", "xmlname": "keyName" }, "AmiLaunchIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The AMI launch index, which can be used to find this instance within the launch group.\n

\n ", "xmlname": "amiLaunchIndex" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique ID of an AWS DevPay product code.\n

\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": null, "xmlname": "type" } }, "documentation": "\n

\n An AWS DevPay product code.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Product codes attached to this instance.\n

\n ", "xmlname": "productCodes" }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "enum": [ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.xlarge", "m3.2xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "i2.xlarge", "i2.2xlarge", "i2.4xlarge", "i2.8xlarge", "hi1.4xlarge", "hs1.8xlarge", "c1.medium", "c1.xlarge", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge" ], "documentation": "\n

\n The instance type. For more information on instance types, please see\n the\n \n Amazon Elastic Compute Cloud Developer Guide.\n

\n ", "xmlname": "instanceType" }, "LaunchTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time this instance launched.\n

\n ", "xmlname": "launchTime" }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The availability zone in which an Amazon EC2 instance runs.\n

\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the PlacementGroup in which an Amazon EC2 instance runs. Placement\n groups are primarily used for launching High Performance Computing instances\n in the same group to ensure fast connection speeds.\n

\n ", "xmlname": "groupName" }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n

\n The allowed tenancy of instances launched into the VPC. A value of default means instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC will be launched as dedicated tenancy regardless of the tenancy assigned to the instance at launch.\n

\n ", "xmlname": "tenancy" } }, "documentation": "\n

\n The location where this instance launched.\n

\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Kernel associated with this instance.\n

\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\n

\n RAM disk associated with this instance.\n

\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\n

\n Platform of the instance (e.g., Windows).\n

\n ", "xmlname": "platform" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\n

\n The state of monitoring on an Amazon EC2 instance (ex: enabled,\n disabled).\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n Monitoring status for this instance.\n

\n ", "xmlname": "monitoring" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC subnet ID in which the instance is running.\n

\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the Amazon VPC in which the instance is running.\n

\n ", "xmlname": "vpcId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the private IP address that is assigned to the instance (Amazon VPC).\n

\n ", "xmlname": "privateIpAddress" }, "PublicIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP address of the instance.\n

\n ", "xmlname": "ipAddress" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\n

\n Reason code for the state change.\n

\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Descriptive message for the state change.\n

\n ", "xmlname": "message" } }, "documentation": "\n

\n The reason for the state change.\n

\n ", "xmlname": "stateReason" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\n

\n The architecture of this instance.\n

\n ", "xmlname": "architecture" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

\n The root device type used by the AMI. The AMI can use an Amazon EBS or\n instance store root device.\n

\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The root device name (e.g., /dev/sda1).\n

\n ", "xmlname": "rootDeviceName" }, "BlockDeviceMappings": { "shape_name": "InstanceBlockDeviceMappingList", "type": "list", "members": { "shape_name": "InstanceBlockDeviceMapping", "type": "structure", "members": { "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The device name (e.g., /dev/sdh) at which the block device is exposed on\n the instance.\n

\n ", "xmlname": "deviceName" }, "Ebs": { "shape_name": "EbsInstanceBlockDevice", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the EBS volume.\n

\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n

\n The status of the EBS volume.\n

\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n

\n The time at which the EBS volume was attached to the associated instance.\n

\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the Amazon EBS volume is deleted on instance termination.\n

\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n

\n The optional EBS device mapped to the specified device name.\n

\n ", "xmlname": "ebs" } }, "documentation": "\n

\n Describes how block devices are mapped on an Amazon EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n Block device mapping set.\n

\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": null, "xmlname": "virtualizationType" }, "InstanceLifecycle": { "shape_name": "InstanceLifecycleType", "type": "string", "enum": [ "spot" ], "documentation": "\n

\n\n

\n ", "xmlname": "instanceLifecycle" }, "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "spotInstanceRequestId" }, "License": { "shape_name": "InstanceLicense", "type": "structure", "members": { "Pool": { "shape_name": "String", "type": "string", "documentation": "\n

\n The license pool from which this license was used (ex: 'windows').\n

\n ", "xmlname": "pool" } }, "documentation": "\n

\n Represents an active license in use and attached to an Amazon EC2 instance.\n

\n ", "xmlname": "license" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "clientToken" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's key.\n

\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The tag's value.\n

\n ", "xmlname": "value" } }, "documentation": "\n

\n Represents metadata to associate with Amazon EC2 resources.\n Each tag consists of a user-defined key and value.\n Use tags to categorize EC2 resources, such as by purpose,\n owner, or environment.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of tags for the Instance.\n

\n ", "xmlname": "tagSet" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Hypervisor": { "shape_name": "HypervisorType", "type": "string", "enum": [ "ovm", "xen" ], "documentation": null, "xmlname": "hypervisor" }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceList", "type": "list", "members": { "shape_name": "InstanceNetworkInterface", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "vpcId" }, "Description": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ownerId" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": null, "xmlname": "status" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n\n

\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "groupId" } }, "documentation": "\n

\n\n

\n ", "xmlname": "item" }, "documentation": null, "xmlname": "groupSet" }, "Attachment": { "shape_name": "InstanceNetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "attachmentId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": null, "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": null, "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": null, "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "deleteOnTermination" } }, "documentation": null, "xmlname": "attachment" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" } }, "documentation": null, "xmlname": "association" }, "PrivateIpAddresses": { "shape_name": "InstancePrivateIpAddressList", "type": "list", "members": { "shape_name": "InstancePrivateIpAddress", "type": "structure", "members": { "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "primary" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ipOwnerId" } }, "documentation": null, "xmlname": "association" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "privateIpAddressesSet" } }, "documentation": null, "xmlname": "item" }, "documentation": null, "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfile", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "arn" }, "Id": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "id" } }, "documentation": null, "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": null, "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "sriovNetSupport" } }, "documentation": "\n

\n Represents an Amazon EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of Amazon EC2 instances included in this reservation.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The newly created reservation, containing the new instances.\n

\n ", "xmlname": "reservation" }, "errors": [], "documentation": "\n

\n The RunInstances operation launches a specified number of instances.\n

\n

\n If Amazon EC2 cannot launch the minimum number AMIs you request, no instances\n launch. If there is insufficient capacity to launch the maximum number of AMIs\n you request, Amazon EC2 launches as many as possible to satisfy the requested\n maximum values.\n

\n

\n Every instance is launched in a security group. If you do not specify a\n security group at launch, the instances start in your default security group.\n For more information on creating security groups, see CreateSecurityGroup.\n

\n

\n An optional instance type can be specified. For information about instance\n types, see Instance Types.\n

\n

\n You can provide an optional key pair ID for each image in the launch request\n (for more information, see CreateKeyPair). All instances that are created from\n images that use this key pair will have access to the associated public key at\n boot. You can use this key to provide secure access to an instance of an image\n on a per-instance basis. Amazon EC2 public images use this feature to provide\n secure access without passwords.\n

\n \n

\n Launching public images without a key pair ID will leave them inaccessible.\n

\n

\n The public key material is made available to the instance at boot time by\n placing it in the openssh_id.pub file on a logical device that is exposed to\n the instance as /dev/sda2 (the ephemeral store). The format of this file is\n suitable for use as an entry within ~/.ssh/authorized_keys (the OpenSSH\n format). This can be done at boot (e.g., as part of rc.local) allowing for\n secure access without passwords.\n

\n

\n Optional user data can be provided in the launch request. All instances that\n collectively comprise the launch request have access to this data For more\n information, see Instance Metadata.\n

\n \n \n If any of the AMIs have a product code attached for which the user has not\n subscribed, the RunInstances call will fail.\n \n \n

\n We strongly recommend using the 2.6.18 Xen stock kernel with the c1.medium and\n c1.xlarge instances. Although the default Amazon EC2 kernels will work, the new\n kernels provide greater stability and performance for these instance types. For\n more information about kernels, see Kernels, RAM Disks, and Block Device\n Mappings.\n

\n \n " }, "StartInstances": { "name": "StartInstances", "input": { "shape_name": "StartInstancesRequest", "type": "structure", "members": { "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of Amazon EC2 instances to start.\n

\n ", "required": true, "flattened": true }, "AdditionalInfo": { "shape_name": "String", "type": "string", "documentation": null }, "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null } }, "documentation": "\n

\n Starts an instance that uses an Amazon EBS volume as its root device.\n

\n

\n Instances that use Amazon EBS volumes as their root devices can be quickly\n stopped and started.\n When an instance is stopped, the compute resources are released and you\n are not billed for hourly instance usage.\n However, your root partition Amazon EBS volume remains, continues to persist\n your data, and you are charged for Amazon EBS volume usage.\n You can restart your instance at any time.\n

\n \n Before stopping an instance, make sure it is in a state from which it\n can be restarted.\n Stopping an instance does not preserve data stored in RAM.\n Performing this operation on an instance that uses an instance store as its root\n device returns an error.\n \n " }, "output": { "shape_name": "StartInstancesResult", "type": "structure", "members": { "StartingInstances": { "shape_name": "InstanceStateChangeList", "type": "list", "members": { "shape_name": "InstanceStateChange", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose state changed.\n

\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The current state of the specified instance.\n

\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The previous state of the specified instance.\n

\n ", "xmlname": "previousState" } }, "documentation": "\n

\n Represents a state change for a specific EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of the starting instances and details on how their state has\n changed.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The result of calling the StartInstances operation.\n Contains details on how the specified instances are changing state.\n

\n " }, "errors": [], "documentation": "\n

\n Starts an instance that uses an Amazon EBS volume as its root device.\n Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.\n When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage.\n However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage.\n You can restart your instance at any time.\n

\n \n

\n Performing this operation on an instance that\n uses an instance store as its root device returns an error.\n

\n \n " }, "StopInstances": { "name": "StopInstances", "input": { "shape_name": "StopInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of Amazon EC2 instances to stop.\n

\n ", "required": true, "flattened": true }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n Forces the instance to stop. The instance will not have an opportunity to\n flush file system caches nor file system meta data.\n If you use this option, you must perform file system check and repair\n procedures. This option is not recommended for Windows\n instances.\n " } }, "documentation": "\n

\n Stops an instance that uses an Amazon EBS volume as its root device.\n

\n

\n Instances that use Amazon EBS volumes as their root devices can be quickly\n stopped and started.\n When an instance is stopped, the compute resources are released and you\n are not billed for hourly instance usage.\n However, your root partition Amazon EBS volume remains, continues to persist\n your data, and you are charged for Amazon EBS volume usage.\n You can restart your instance at any time.\n

\n \n Before stopping an instance, make sure it is in a state from which it\n can be restarted.\n Stopping an instance does not preserve data stored in RAM.\n Performing this operation on an instance that uses an instance store as its root\n device returns an error.\n \n " }, "output": { "shape_name": "StopInstancesResult", "type": "structure", "members": { "StoppingInstances": { "shape_name": "InstanceStateChangeList", "type": "list", "members": { "shape_name": "InstanceStateChange", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose state changed.\n

\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The current state of the specified instance.\n

\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The previous state of the specified instance.\n

\n ", "xmlname": "previousState" } }, "documentation": "\n

\n Represents a state change for a specific EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of the stopping instances and details on how their state has\n changed.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The result of calling the StopInstances operation.\n Contains details on how the specified instances are changing state.\n

\n " }, "errors": [], "documentation": "\n

\n Stops an instance that uses an Amazon EBS volume as its root device.\n Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.\n When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage.\n However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage.\n You can restart your instance at any time.\n

\n \n

\n Before stopping an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not\n preserve data stored in RAM.\n

\n

\n Performing this operation on an instance that uses an instance\n store as its root device returns an error.\n

\n \n " }, "TerminateInstances": { "name": "TerminateInstances", "input": { "shape_name": "TerminateInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of instances to terminate.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n A request to shut down one or more instances. This operation is\n idempotent; if you terminate an instance more than once, each\n call will succeed.\n Terminated instances will remain visible after termination (for approximately\n one hour).\n

\n \n By default, Amazon EC2 deletes all Amazon EBS volumes that were\n attached when the instance launched.\n Amazon EBS volumes attached after instance launch continue running.\n \n " }, "output": { "shape_name": "TerminateInstancesResult", "type": "structure", "members": { "TerminatingInstances": { "shape_name": "InstanceStateChangeList", "type": "list", "members": { "shape_name": "InstanceStateChange", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the instance whose state changed.\n

\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The current state of the specified instance.\n

\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n A 16-bit unsigned integer. The high byte is an opaque internal value\n and should be ignored. The low byte is set based on the state\n represented.\n

\n ", "xmlname": "code" }, "Name": { "shape_name": "InstanceStateName", "type": "string", "enum": [ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ], "documentation": "\n

\n The current state of the instance.\n

\n ", "xmlname": "name" } }, "documentation": "\n

\n The previous state of the specified instance.\n

\n ", "xmlname": "previousState" } }, "documentation": "\n

\n Represents a state change for a specific EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n The list of the terminating instances and details on how their state has\n changed.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The result of calling the TerminateInstances operation.\n Contains details on how the specified instances are changing state.\n

\n " }, "errors": [], "documentation": "\n

\n The TerminateInstances operation shuts down one or more instances. This\n operation is idempotent; if you terminate an instance more than once, each call\n will succeed.\n

\n

\n Terminated instances will remain visible after termination (approximately one\n hour).\n

\n " }, "UnassignPrivateIpAddresses": { "name": "UnassignPrivateIpAddresses", "input": { "shape_name": "UnassignPrivateIpAddressesRequest", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": null, "required": true }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "PrivateIpAddress" }, "documentation": null, "required": true, "flattened": true } }, "documentation": null }, "output": null, "errors": [], "documentation": null }, "UnmonitorInstances": { "name": "UnmonitorInstances", "input": { "shape_name": "UnmonitorInstancesRequest", "type": "structure", "members": { "DryRun": { "shape_name": "Boolean", "type": "boolean", "documentation": null }, "InstanceIds": { "shape_name": "InstanceIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "InstanceId" }, "documentation": "\n

\n The list of Amazon EC2 instances on which to disable monitoring.\n

\n ", "required": true, "flattened": true } }, "documentation": "\n

\n A request to disable monitoring for an Amazon EC2 instance.\n

\n " }, "output": { "shape_name": "UnmonitorInstancesResult", "type": "structure", "members": { "InstanceMonitorings": { "shape_name": "InstanceMonitoringList", "type": "list", "members": { "shape_name": "InstanceMonitoring", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Instance ID.\n

\n ", "xmlname": "instanceId" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\n

\n The state of monitoring on an Amazon EC2 instance (ex: enabled,\n disabled).\n

\n ", "xmlname": "state" } }, "documentation": "\n

\n Monitoring state for the associated instance.\n

\n ", "xmlname": "monitoring" } }, "documentation": "\n

\n Represents the monitoring state of an EC2 instance.\n

\n ", "xmlname": "item" }, "documentation": "\n

\n A list of updated monitoring information for the instances specified in\n the request.\n

\n ", "xmlname": "instancesSet" } }, "documentation": "\n

\n The result of calling the UnmonitorInstances operation.\n Contains the updated monitoring status for each instance specified in the\n request.\n

\n " }, "errors": [], "documentation": "\n

\n Disables monitoring for a running instance.\n

\n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://ec2.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "InstanceStatuses", "py_input_token": "next_token" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "ReservedInstancesOfferings", "py_input_token": "next_token" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "SpotPriceHistory", "py_input_token": "next_token" }, "DescribeVolumeStatus": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "VolumeStatuses", "py_input_token": "next_token" }, "DescribeInstances": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Reservations", "py_input_token": "next_token" }, "DescribeTags": { "input_token": "NextToken", "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Tags", "py_input_token": "next_token" } }, "waiters": { "ConversionTaskCancelled": { "failure": { "path": "ConversionTasks[].State", "type": "output" }, "operation": "DescribeConversionTasks", "success": { "path": "ConversionTasks[].State", "type": "output", "value": [ "cancelled" ] }, "interval": 15, "max_attempts": 40 }, "VolumeAvailable": { "success": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output", "value": [ "available" ] }, "interval": 15, "failure": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output", "value": [ "deleted" ] }, "operation": "DescribeVolumes", "max_attempts": 40 }, "ExportTaskCancelled": { "failure": { "path": "ExportTasks[].State", "type": "output" }, "operation": "DescribeExportTasks", "success": { "path": "ExportTasks[].State", "type": "output", "value": [ "cancelled" ] }, "interval": 15, "max_attempts": 40 }, "CustomerGatewayAvailable": { "success": { "path": "CustomerGateways[].State", "type": "output", "value": [ "available" ] }, "interval": 15, "failure": { "path": "CustomerGateways[].State", "type": "output", "value": [ "deleted", "deleting" ] }, "operation": "DescribeCustomerGateways", "max_attempts": 40 }, "ConversionTaskCompleted": { "success": { "path": "ConversionTasks[].State", "type": "output", "value": [ "completed" ] }, "interval": 15, "failure": { "path": "ConversionTasks[].State", "type": "output", "value": [ "cancelled", "cancelling" ] }, "operation": "DescribeConversionTasks", "max_attempts": 40 }, "VpnConnectionDeleted": { "success": { "path": "VpnConnections[].State", "type": "output", "value": [ "deleted" ] }, "interval": 15, "failure": { "path": "VpnConnections[].State", "type": "output", "value": [ "pending" ] }, "operation": "DescribeVpnConnections", "max_attempts": 40 }, "BundleTaskComplete": { "failure": { "path": "BundleTasks[].State", "type": "output", "value": [ "failed" ] }, "operation": "DescribeBundleTasks", "success": { "path": "BundleTasks[].State", "type": "output", "value": [ "complete" ] }, "interval": 15, "max_attempts": 40 }, "VolumeInUse": { "success": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output", "value": [ "in-use" ] }, "interval": 15, "failure": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output", "value": [ "deleted" ] }, "operation": "DescribeVolumes", "max_attempts": 40 }, "VpnConnectionAvailable": { "success": { "path": "VpnConnections[].State", "type": "output", "value": [ "available" ] }, "interval": 15, "failure": { "path": "VpnConnections[].State", "type": "output", "value": [ "deleting", "deleted" ] }, "operation": "DescribeVpnConnections", "max_attempts": 40 }, "InstanceRunning": { "success": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "running" ] }, "interval": 15, "failure": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "shutting-down", "terminated", "stopping" ] }, "operation": "DescribeInstances", "max_attempts": 40 }, "ConversionTaskDeleted": { "failure": { "path": "CustomerGateways[].State", "type": "output" }, "operation": "DescribeCustomerGateways", "success": { "path": "CustomerGateways[].State", "type": "output", "value": [ "deleted" ] }, "interval": 15, "max_attempts": 40 }, "VpcAvailable": { "success": { "path": "Vpcs[].State", "type": "output", "value": [ "available" ] }, "interval": 15, "failure": { "type": "output" }, "operation": "DescribeVpcs", "max_attempts": 40 }, "SubnetAvailable": { "success": { "path": "Subnets[].State", "type": "output", "value": [ "available" ] }, "interval": 15, "failure": { "type": "output" }, "operation": "DescribeSubnets", "max_attempts": 40 }, "InstanceTerminated": { "success": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "terminated" ] }, "interval": 15, "failure": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "pending", "stopping" ] }, "operation": "DescribeInstances", "max_attempts": 40 }, "VolumeDeleted": { "failure": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output" }, "operation": "DescribeVolumes", "success": { "path": "VolumeStatuses[].VolumeStatus.Status", "type": "output", "value": [ "deleted" ] }, "interval": 15, "max_attempts": 40 }, "InstanceStopped": { "success": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "stopped" ] }, "interval": 15, "failure": { "path": "Reservations[].Instances[].State.Name", "type": "output", "value": [ "pending", "terminated" ] }, "operation": "DescribeInstances", "max_attempts": 40 }, "SnapshotCompleted": { "success": { "path": "Snapshots[].State", "type": "output", "value": [ "completed" ] }, "interval": 15, "failure": { "type": "output" }, "operation": "DescribeSnapshots", "max_attempts": 40 }, "ExportTaskCompleted": { "failure": { "path": "ExportTasks[].State", "type": "output" }, "operation": "DescribeExportTasks", "success": { "path": "ExportTasks[].State", "type": "output", "value": [ "completed" ] }, "interval": 15, "max_attempts": 40 } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "RequestLimitExceeded", "http_status_code": 503 } } } } } } }botocore-0.29.0/botocore/data/aws/elasticache.json0000644000175000017500000143405312254746566021422 0ustar takakitakaki{ "api_version": "2013-06-15", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon ElastiCache", "endpoint_prefix": "elasticache", "xmlnamespace": "http://elasticache.amazonaws.com/doc/2013-06-15/", "documentation": "\n Amazon ElastiCache\n

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a\n distributed cache in the cloud.

\n

With ElastiCache, customers gain all of the benefits of a high-performance,\n in-memory cache with far less of the administrative burden of launching and managing a\n distributed cache. The service makes set-up, scaling, and cluster failure handling much\n simpler than in a self-managed cache deployment.

\n

In addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.

\n ", "operations": { "AuthorizeCacheSecurityGroupIngress": { "name": "AuthorizeCacheSecurityGroupIngress", "input": { "shape_name": "AuthorizeCacheSecurityGroupIngressMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The cache security group which will allow network ingress.

\n ", "required": true }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon EC2 security group to be authorized for ingress to the cache security group.

\n ", "required": true }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access\n key ID - you must provide a valid AWS account number for this parameter.

\n ", "required": true } }, "documentation": "\n

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the cache security group owner.

\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache security group.

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the Amazon EC2 security group owner.

\n " } }, "documentation": "\n

Provides ownership and status information for an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

A list of Amazon EC2 security groups that are associated with this cache security group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n " } } }, "errors": [ { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache security group does not allow deletion.

\n " }, { "shape_name": "AuthorizationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

The specified Amazon EC2 security group is already authorized for the specified cache security\n group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and\n Amazon EC2 security groups are used as the authorization mechanism.

\n You cannot authorize ingress from an Amazon EC2 security group in one Region to an ElastiCache\n cluster in another Region. \n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=AuthorizeCacheSecurityGroupIngress\n &EC2SecurityGroupName=default\n &CacheSecurityGroupName=mygroup\n &EC2SecurityGroupOwnerId=1234-5678-1234\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-12T01%3A29%3A15.746Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n \n authorizing\n default\n 565419523791\n \n \n mygroup\n 123456781234\n My security group\n \n \n \n 817fa999-3647-11e0-ae57-f96cfe56749c\n \n\n \n \n " }, "CreateCacheCluster": { "name": "CreateCacheCluster", "input": { "shape_name": "CreateCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache cluster identifier. This parameter is stored as a lowercase string.

\n \n

Constraints:

\n\n ", "required": true }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster should belong. If this parameter is\n specified, the cache cluster will be added to the specified replication group as a read\n replica; otherwise, the cache cluster will be a standalone primary that is not part of\n any replication group.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The initial number of cache nodes that the cache cluster will have.

\n

For a Memcached cluster, valid values are between 1 and 20. If you need to exceed this\n limit, please fill out the ElastiCache Limit Increase Request form at .

\n

For Redis, only single-node cache clusters are supported at this time, so the value for\n this parameter must be 1.

\n ", "required": true }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The compute and memory capacity of the nodes in the cache cluster.

\n

Valid values for Memcached:

\n

\n cache.t1.micro | \n cache.m1.small | \n cache.m1.medium |\n cache.m1.large | \n cache.m1.xlarge | \n cache.m3.xlarge | \n cache.m3.2xlarge | \n cache.m2.xlarge | \n cache.m2.2xlarge |\n cache.m2.4xlarge | \n cache.c1.xlarge\n

\n

Valid values for Redis:

\n

\n cache.t1.micro | \n cache.m1.small | \n cache.m1.medium |\n cache.m1.large | \n cache.m1.xlarge | \n cache.m2.xlarge | \n cache.m2.2xlarge | \n cache.m2.4xlarge | \n cache.c1.xlarge\n

\n

For a complete listing of cache node types and specifications, see .

\n ", "required": true }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine to be used for this cache cluster.

\n

Valid values for this parameter are:

\n

memcached | redis

\n ", "required": true }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

\n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to associate with this cache cluster. If this\n argument is omitted, the default cache parameter group for the specified engine will be\n used.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group to be used for the cache cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).

\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\n

A list of cache security group names to associate with this cache cluster.

\n

Use this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (VPC).

\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n

One or more VPC security groups associated with the cache cluster.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).

\n " }, "SnapshotArns": { "shape_name": "SnapshotArnsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SnapshotArn" }, "documentation": "\n

A single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to\n populate the Redis cache in the new cache cluster. The Amazon S3 object name in the ARN\n cannot contain any commas.

\n\n

Here is an example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

\n\n

Note: This parameter is only valid if the Engine parameter is redis.

\n \n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The EC2 Availability Zone in which the cache cluster will be created.

\n

All cache nodes belonging to a cache cluster are placed in the preferred availability\n zone.

\n

Default: System chosen availability zone.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The weekly time range (in UTC) during which system maintenance can occur.

\n

Example: sun:05:00-sun:09:00\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The port number on which each of the cache nodes will accept connections.

\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to\n which notifications will be sent.

\n The Amazon SNS topic owner must be the same as the cache cluster owner. \n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

Determines whether minor engine upgrades will be applied automatically to the cache\n cluster during the maintenance window. A value of true allows these upgrades\n to occur; false disables automatic upgrades.

\n

Default: true

\n " } }, "documentation": "\n

Represents the input of a CreateCacheCluster operation.

\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied identifier of the cache cluster. This is a unique key that identifies\n a cache cluster.

\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the web page where you can download the latest ElastiCache client library.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the compute and memory capacity node type for the cache cluster.

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine (memcached or redis) to be used for this cache cluster.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the cache engine version that is used in this cache cluster.

\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache cluster - creating, available, etc.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes in the cache cluster.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the cache cluster is located.

\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache cluster was created.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The time range (in UTC) during which weekly system maintenance can occur.

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The new number of cache nodes for the cache cluster.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The new cache engine version that the cache cluster will run.

\n " } }, "documentation": "\n

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) that identifies the topic.

\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of the topic.

\n " } }, "documentation": "\n

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a cache cluster's status within a particular cache security group.

\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security group elements, composed of name and status sub-elements.

\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of parameter updates.

\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

\n " } }, "documentation": "\n

The status of the cache parameter group.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group associated with the cache cluster.

\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.

\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache node.

\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache node was created.

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

The hostname and IP address for connecting to this cache node.

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the parameter group applied to this cache node.

\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this\n node is not associated with a primary cache cluster.

\n " } }, "documentation": "\n

Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n ", "xmlname": "CacheNode" }, "documentation": "\n

A list of cache nodes that are members of the cache cluster.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupMembershipList", "type": "list", "members": { "shape_name": "SecurityGroupMembership", "type": "structure", "members": { "SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a single cache security group and its status..

\n " }, "documentation": "\n

A list of VPC Security Groups associated with the cache cluster.

\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific cache cluster.

\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified replication group does not exist.

\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested replication group is not in the available state.

\n " }, { "shape_name": "CacheClusterAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

This user already has a cache cluster with the given identifier.

\n " }, { "shape_name": "InsufficientCacheClusterCapacityFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache node type is not available in the specified Availability Zone.

\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group name does not refer to an existing cache subnet group.

\n " }, { "shape_name": "ClusterQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of cache clusters per\n customer.

\n " }, { "shape_name": "NodeQuotaForClusterExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed\n number of cache nodes in a single cache cluster.

\n " }, { "shape_name": "NodeQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.\n

\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

The VPC network is in an invalid state.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The CreateCacheCluster operation creates a new cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software - either Memcached or Redis.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateCacheCluster\n &NumCacheNodes=3\n &CacheClusterId=mycache\n &Engine=memcached\n &CacheSecurityGroupNames.member.1=default\n &CacheNodeType=cache.m1.large\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T00%3A33%3A09.322Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n creating\n 3\n memcached\n \n 1.4.5\n true\n sun:08:00-sun:09:00\n cache.m1.large\n \n \n default\n active\n \n \n mycache\n \n \n \n aaf2e796-363f-11e0-a564-8f11342c56b0\n \n\n \n \n " }, "CreateCacheParameterGroup": { "name": "CreateCacheParameterGroup", "input": { "shape_name": "CreateCacheParameterGroupMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

A user-specified name for the cache parameter group.

\n ", "required": true }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group family the cache parameter group can be used with.

\n

Valid values are: memcached1.4 | redis2.6

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A user-specified description for the cache parameter group.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateCacheParameterGroup operation.

\n " }, "output": { "shape_name": "CacheParameterGroupWrapper", "type": "structure", "members": { "CacheParameterGroup": { "shape_name": "CacheParameterGroup", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group family that this cache parameter group is\n compatible with.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description for this cache parameter group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of a CreateCacheParameterGroup operation.

\n " } } }, "errors": [ { "shape_name": "CacheParameterGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the maximum number of cache\n security groups.

\n " }, { "shape_name": "CacheParameterGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

A cache parameter group with the requested name already\n exists.

\n " }, { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache parameter group does not allow the requested action to\n occur.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateCacheParameterGroup\n &Description=My%20first%20cache%20parameter%20group\n &CacheParameterGroupFamily=memcached1.4\n &CacheParameterGroupName=mycacheparametergroup1\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A34%3A47.462Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n \n\n \n \n mycacheparametergroup3\n memcached1.4\n My first cache parameter group\n \n \n \n 05699541-b7f9-11e0-9326-b7275b9d4a6c\n \n\n \n \n \n " }, "CreateCacheSecurityGroup": { "name": "CreateCacheSecurityGroup", "input": { "shape_name": "CreateCacheSecurityGroupMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

A name for the cache security group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be the word \"Default\".

\n

Example: mysecuritygroup

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description for the cache security group.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateCacheSecurityGroup operation.

\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the cache security group owner.

\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache security group.

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the Amazon EC2 security group owner.

\n " } }, "documentation": "\n

Provides ownership and status information for an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

A list of Amazon EC2 security groups that are associated with this cache security group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n " } } }, "errors": [ { "shape_name": "CacheSecurityGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

A cache security group with the specified name already exists.

\n " }, { "shape_name": "CacheSecurityGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of cache\n security groups.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The CreateCacheSecurityGroup operation creates a new cache security group. Use a\n cache security group to control access to one or more cache clusters.

\n

Cache security groups are only used when you are creating a cluster outside of an\n Amazon Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a\n cache subnet group instead. For more information, see CreateCacheSubnetGroup.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=CreateCacheSecurityGroup\n &CacheSecurityGroupName=mycachesecuritygroup\n &Description=My%20cache%20security%20group\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A43%3A10.703Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n mycachesecuritygroup\n 123456789012\n My cache security group\n \n \n \n 2b1c8035-b7fa-11e0-9326-b7275b9d4a6c\n \n\n\n \n \n " }, "CreateCacheSubnetGroup": { "name": "CreateCacheSubnetGroup", "input": { "shape_name": "CreateCacheSubnetGroupMessage", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

A name for the cache subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup

\n ", "required": true }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

A description for the cache subnet group.

\n ", "required": true }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

A list of VPC subnet IDs for the cache subnet group.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateCacheSubnetGroup operation.

\n " }, "output": { "shape_name": "CacheSubnetGroupWrapper", "type": "structure", "members": { "CacheSubnetGroup": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group.

\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache subnet group.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the subnet

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the availability zone.

\n " } }, "wrapper": true, "documentation": "\n

The Availability Zone associated with the subnet

\n " } }, "documentation": "\n

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

\n ", "xmlname": "Subnet" }, "documentation": "\n

A list of subnets associated with the cache subnet group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n " } } }, "errors": [ { "shape_name": "CacheSubnetGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group name is already in use by an existing cache subnet\n group.

\n " }, { "shape_name": "CacheSubnetGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

\n " }, { "shape_name": "CacheSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet\n group.

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

An invalid subnet identifier was specified.

\n " } ], "documentation": "\n

The CreateCacheSubnetGroup operation creates a new cache subnet group.

\n

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

\n \n https://elasticache.amazonaws.com/\n ?Action=CreateCacheSubnetGroup\n &CacheSubnetGroupName=myCachesubnetgroup\n &CacheSubnetGroupDescription=My%20new%20CacheSubnetGroup\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 990524496922\n My new CacheSubnetGroup\n myCachesubnetgroup\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n \n " }, "CreateReplicationGroup": { "name": "CreateReplicationGroup", "input": { "shape_name": "CreateReplicationGroupMessage", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group identifier. This parameter is stored as a lowercase string.

\n \n

Constraints:

\n\n\n ", "required": true }, "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of \n available.

\n ", "required": true }, "ReplicationGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

A user-specified description for the replication group.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateReplicationGroup operation.

\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the replication group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during\n the next maintenance window.

\n " } }, "documentation": "\n

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\n

The names of all the cache clusters that are part of this replication group.

\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the cache cluster to which the node belongs.

\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the node is located.

\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\n

The role that is currently assigned to the node - primary or replica.

\n " } }, "documentation": "\n

Represents a single node within a node group.

\n ", "xmlname": "NodeGroupMember" }, "documentation": "\n

A list containing information about individual nodes within the node group.

\n " } }, "documentation": "\n

Represents a collection of cache nodes in a replication group.

\n ", "xmlname": "NodeGroup" }, "documentation": "\n

A single element list with information about the nodes in the replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific replication group.

\n " } } }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster is not in the available state.

\n " }, { "shape_name": "ReplicationGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

The specified replication group already exists.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The CreateReplicationGroup operation creates a replication group. A replication\n group is a collection of cache clusters, where one of the clusters is a\n read/write primary and the other clusters are read-only replicas. Writes to the primary are\n automatically propagated to the replicas.

\n

When you create a replication group, you must specify an existing cache cluster that is\n in the primary role. When the replication group has been successfully created, you can\n add one or more read replica replicas to it, up to a total of five read replicas.

\n " }, "DeleteCacheCluster": { "name": "DeleteCacheCluster", "input": { "shape_name": "DeleteCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteCacheCluster operation.

\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied identifier of the cache cluster. This is a unique key that identifies\n a cache cluster.

\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the web page where you can download the latest ElastiCache client library.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the compute and memory capacity node type for the cache cluster.

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine (memcached or redis) to be used for this cache cluster.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the cache engine version that is used in this cache cluster.

\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache cluster - creating, available, etc.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes in the cache cluster.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the cache cluster is located.

\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache cluster was created.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The time range (in UTC) during which weekly system maintenance can occur.

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The new number of cache nodes for the cache cluster.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The new cache engine version that the cache cluster will run.

\n " } }, "documentation": "\n

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) that identifies the topic.

\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of the topic.

\n " } }, "documentation": "\n

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a cache cluster's status within a particular cache security group.

\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security group elements, composed of name and status sub-elements.

\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of parameter updates.

\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

\n " } }, "documentation": "\n

The status of the cache parameter group.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group associated with the cache cluster.

\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.

\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache node.

\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache node was created.

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

The hostname and IP address for connecting to this cache node.

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the parameter group applied to this cache node.

\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this\n node is not associated with a primary cache cluster.

\n " } }, "documentation": "\n

Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n ", "xmlname": "CacheNode" }, "documentation": "\n

A list of cache nodes that are members of the cache cluster.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupMembershipList", "type": "list", "members": { "shape_name": "SecurityGroupMembership", "type": "structure", "members": { "SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a single cache security group and its status..

\n " }, "documentation": "\n

A list of VPC Security Groups associated with the cache cluster.

\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific cache cluster.

\n " } } }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster is not in the available state.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DeleteCacheCluster operation deletes a previously provisioned cache cluster.\n DeleteCacheCluster deletes all associated cache nodes, node endpoints and the\n cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache\n immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheCluster\n &CacheClusterId=simcoprod43&Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A46%3A46.129Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n in-sync\n default.memcached1.4\n \n \n simcoprod43\n deleting\n \n 11211\n
simcoprod43.m2st2p.cfg.cache.amazonaws.com
\n \n cache.m1.large\n memcached\n \n us-east-1b\n 2011-07-27T02:18:26.497Z\n 1.4.5\n true\n mon:05:00-mon:05:30\n \n \n default\n active\n \n \n 3\n \n \n \n ab84aa7e-b7fa-11e0-9b0b-a9261be2b354\n \n\n \n \n " }, "DeleteCacheParameterGroup": { "name": "DeleteCacheParameterGroup", "input": { "shape_name": "DeleteCacheParameterGroupMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to delete.

\n The specified cache security group must not be associated with any cache clusters.\n \n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteCacheParameterGroup operation.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache parameter group does not allow the requested action to\n occur.

\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DeleteCacheParameterGroup operation deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheParameterGroup\n &CacheParameterGroupName=myparametergroup\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-25T21%3A16%3A39.166Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n \n\n \n d0a417cb-575b-11e0-8869-cd22b4f9d96f\n \n\n \n \n \n " }, "DeleteCacheSecurityGroup": { "name": "DeleteCacheSecurityGroup", "input": { "shape_name": "DeleteCacheSecurityGroupMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group to delete.

\n You cannot delete the default security group.\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteCacheSecurityGroup operation.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache security group does not allow deletion.

\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DeleteCacheSecurityGroup operation deletes a cache security group.

\n You cannot delete a cache security group if it is associated with any cache clusters.\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DeleteCacheSecurityGroup\n &CacheSecurityGroupName=mycachesecuritygroup3\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A54%3A12.418Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n c130cfb7-3650-11e0-ae57-f96cfe56749c\n \n\n \n " }, "DeleteCacheSubnetGroup": { "name": "DeleteCacheSubnetGroup", "input": { "shape_name": "DeleteCacheSubnetGroupMessage", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group to delete.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteCacheSubnetGroup operation.

\n " }, "output": null, "errors": [ { "shape_name": "CacheSubnetGroupInUse", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group is currently in use.

\n " }, { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group name does not refer to an existing cache subnet group.

\n " } ], "documentation": "\n

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

\n You cannot delete a cache subnet group if it is associated with any cache clusters.\n \n https://elasticache.amazonaws.com/\n ?Action=DeleteCacheSubnetGroup\n &CacheSubnetGroupName=mysubnetgroup\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A48%3A21.746Z\n &AWSAccessKeyId=\n &Signature=\n \n \n 5d013245-4172-11df-8520-e7e1e602a915\n \n \n \n " }, "DeleteReplicationGroup": { "name": "DeleteReplicationGroup", "input": { "shape_name": "DeleteReplicationGroupMessage", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group to be deleted. This parameter is not case\n sensitive.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteReplicationGroup operation.

\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the replication group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during\n the next maintenance window.

\n " } }, "documentation": "\n

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\n

The names of all the cache clusters that are part of this replication group.

\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the cache cluster to which the node belongs.

\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the node is located.

\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\n

The role that is currently assigned to the node - primary or replica.

\n " } }, "documentation": "\n

Represents a single node within a node group.

\n ", "xmlname": "NodeGroupMember" }, "documentation": "\n

A list containing information about individual nodes within the node group.

\n " } }, "documentation": "\n

Represents a collection of cache nodes in a replication group.

\n ", "xmlname": "NodeGroup" }, "documentation": "\n

A single element list with information about the nodes in the replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific replication group.

\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified replication group does not exist.

\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested replication group is not in the available state.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DeleteReplicationGroup operation deletes an existing replication group.\n DeleteReplicationGroup deletes the primary cache cluster and all of the read replicas in the replication\n group. When you receive a successful response\n from this operation, Amazon ElastiCache immediately begins deleting the entire replication group; you\n cannot cancel or revert this operation.

\n " }, "DescribeCacheClusters": { "name": "DescribeCacheClusters", "input": { "shape_name": "DescribeCacheClustersMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cache cluster is returned. This parameter isn't case sensitive.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n" }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " }, "ShowCacheNodeInfo": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

An optional flag that can be included in the DescribeCacheCluster request to retrieve\n information about the individual cache nodes.

\n " } }, "documentation": "\n

Represents the input of a DescribeCacheClusters operation.

\n " }, "output": { "shape_name": "CacheClusterMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "CacheClusters": { "shape_name": "CacheClusterList", "type": "list", "members": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied identifier of the cache cluster. This is a unique key that identifies\n a cache cluster.

\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the web page where you can download the latest ElastiCache client library.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the compute and memory capacity node type for the cache cluster.

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine (memcached or redis) to be used for this cache cluster.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the cache engine version that is used in this cache cluster.

\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache cluster - creating, available, etc.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes in the cache cluster.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the cache cluster is located.

\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache cluster was created.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The time range (in UTC) during which weekly system maintenance can occur.

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The new number of cache nodes for the cache cluster.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The new cache engine version that the cache cluster will run.

\n " } }, "documentation": "\n

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) that identifies the topic.

\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of the topic.

\n " } }, "documentation": "\n

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a cache cluster's status within a particular cache security group.

\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security group elements, composed of name and status sub-elements.

\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of parameter updates.

\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

\n " } }, "documentation": "\n

The status of the cache parameter group.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group associated with the cache cluster.

\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.

\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache node.

\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache node was created.

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

The hostname and IP address for connecting to this cache node.

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the parameter group applied to this cache node.

\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this\n node is not associated with a primary cache cluster.

\n " } }, "documentation": "\n

Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n ", "xmlname": "CacheNode" }, "documentation": "\n

A list of cache nodes that are members of the cache cluster.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupMembershipList", "type": "list", "members": { "shape_name": "SecurityGroupMembership", "type": "structure", "members": { "SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a single cache security group and its status..

\n " }, "documentation": "\n

A list of VPC Security Groups associated with the cache cluster.

\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific cache cluster.

\n ", "xmlname": "CacheCluster" }, "documentation": "\n

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheClusters operation.

\n " }, "errors": [ { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeCacheClusters operation returns information about all provisioned\n cache clusters if no cache cluster identifier is specified, or about a specific cache\n cluster if a cache cluster identifier is supplied.

\n

By default, abbreviated information about the cache clusters(s) will be returned. You can use\n the optional ShowDetails flag to retrieve detailed information about the cache\n nodes associated with the cache clusters. These details include the DNS address and port for\n the cache node endpoint.

\n

If the cluster is in the CREATING state, only cluster level information will be displayed\n until all of the nodes are successfully provisioned.

\n

If the cluster is in the DELETING state, only cluster level information will be\n displayed.

\n

If cache nodes are currently being added to the cache cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the cache cluster state is available, the cluster is ready for use.

\n

If cache nodes are currently being removed from the cache cluster, no endpoint\n information for the removed nodes is displayed.

\n\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheClusters\n &MaxRecords=100\n &Version=2013-06-15\n &ShowCacheNodeInfo=false\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A55%3A54.654Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n \n in-sync\n default.memcached1.4\n \n \n simcoprod42\n available\n \n 11211\n
simcoprod42.m2st2p.cfg.cache.amazonaws.com
\n \n \n https://console.aws.amazon.com/elasticache/home#client-download:\n \n cache.m1.large\n memcached\n \n us-east-1d\n 2011-07-26T01:21:46.607Z\n 1.4.5\n true\n fri:08:30-fri:09:00\n \n \n default\n active\n \n \n \n active\n arn:aws:sns:us-east-1:123456789012:ElastiCacheNotifications\n \n 6\n \n \n \n \n f270d58f-b7fb-11e0-9326-b7275b9d4a6c\n \n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheClusters", "py_input_token": "marker" } }, "DescribeCacheEngineVersions": { "name": "DescribeCacheEngineVersions", "input": { "shape_name": "DescribeCacheEngineVersionsMessage", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The cache engine to return. Valid values: memcached | redis

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The cache engine version to return.

\n

Example: 1.4.14

\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of a specific cache parameter group family to return details for.

\n

Constraints:

\n \n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " }, "DefaultOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, specifies that only the default version of the specified engine or engine and major\n version combination is to be returned.

\n " } }, "documentation": "\n

Represents the input of a DescribeCacheEngineVersions operation.

\n " }, "output": { "shape_name": "CacheEngineVersionMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "CacheEngineVersions": { "shape_name": "CacheEngineVersionList", "type": "list", "members": { "shape_name": "CacheEngineVersion", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version number of the cache engine.

\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group family associated with this cache engine.

\n " }, "CacheEngineDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache engine.

\n " }, "CacheEngineVersionDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache engine version.

\n " } }, "documentation": "\n

Provides all of the details about a particular cache engine version.

\n ", "xmlname": "CacheEngineVersion" }, "documentation": "\n

A list of cache engine version details. Each element in the list contains detailed information about once cache engine version.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheEngineVersions operation.

\n " }, "errors": [], "documentation": "\n

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheEngineVersions\n &MaxRecords=100\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T07%3A34%3A17.435Z\n &AWSAccessKeyId=\n &Signature=\n \n\n \n \n \n memcached1.4\n memcached\n memcached version 1.4.14\n memcached\n 1.4.14\n \n \n memcached1.4\n memcached\n memcached version 1.4.5\n memcached\n 1.4.5\n \n \n \n \n a6ac9ad2-f8a4-11e1-a4d1-a345e5370093\n \n\n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheEngineVersions", "py_input_token": "marker" } }, "DescribeCacheParameterGroups": { "name": "DescribeCacheParameterGroups", "input": { "shape_name": "DescribeCacheParameterGroupsMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of a specific cache parameter group to return details for.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeCacheParameterGroups operation.

\n " }, "output": { "shape_name": "CacheParameterGroupsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "CacheParameterGroups": { "shape_name": "CacheParameterGroupList", "type": "list", "members": { "shape_name": "CacheParameterGroup", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group family that this cache parameter group is\n compatible with.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description for this cache parameter group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of a CreateCacheParameterGroup operation.

\n ", "xmlname": "CacheParameterGroup" }, "documentation": "\n

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheParameterGroups operation.

\n " }, "errors": [ { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeCacheParameterGroups operation returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list will contain only\n the descriptions for that group.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheParameterGroups\n &MaxRecords=100\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T01%3A34%3A31.045Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n default.memcached1.4\n memcached1.4\n Default parameter group for memcached1.4\n \n \n mycacheparametergroup\n memcached1.4\n My cache parameter group\n \n \n mycacheparametergroup1\n memcached1.4\n My first cache parameter group\n \n \n mycacheparametergroup3\n memcached1.4\n My first cache parameter group\n \n \n \n \n 7193fbb8-b7fc-11e0-9b0b-a9261be2b354\n \n\n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheParameterGroups", "py_input_token": "marker" } }, "DescribeCacheParameters": { "name": "DescribeCacheParameters", "input": { "shape_name": "DescribeCacheParametersMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of a specific cache parameter group to return details for.

\n ", "required": true }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

The parameter types to return.

\n

Valid values: user | system | engine-default\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeCacheParameters operation.

\n " }, "output": { "shape_name": "CacheParameterGroupDetails", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

The value of the parameter.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the parameter.

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

The source of the parameter.

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

The valid data type for the parameter.

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

The valid range of values for the parameter.

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The earliest cache engine version to which the parameter can apply.

\n " } }, "documentation": "\n

Describes an individual setting that controls some aspect of ElastiCache behavior.

\n ", "xmlname": "Parameter" }, "documentation": "\n

A list of Parameter instances.

\n " }, "CacheNodeTypeSpecificParameters": { "shape_name": "CacheNodeTypeSpecificParametersList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificParameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the parameter.

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

The source of the parameter value.

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

The valid data type for the parameter.

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

The valid range of values for the parameter.

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The earliest cache engine version to which the parameter can apply.

\n " }, "CacheNodeTypeSpecificValues": { "shape_name": "CacheNodeTypeSpecificValueList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificValue", "type": "structure", "members": { "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type for which this value applies.

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

The value for the cache node type.

\n " } }, "documentation": "\n

A value that applies only to a certain cache node type.

\n ", "xmlname": "CacheNodeTypeSpecificValue" }, "documentation": "\n

A list of cache node types and their corresponding values for this parameter.

\n " } }, "documentation": "\n

A parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.

\n ", "xmlname": "CacheNodeTypeSpecificParameter" }, "documentation": "\n

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheParameters operation.

\n " }, "errors": [ { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.

\n \n \n Some of the output has been omitted for brevity. \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheParameters\n &CacheParameterGroupName=default.memcached1.4\n &MaxRecords=100\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T03%3A07%3A23.039Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n \n \n cache.c1.xlarge\n 6000\n \n \n (...output omitted...)\n\n \n integer\n system\n false\n The maximum configurable amount of memory to use to store items, in megabytes.\n 1-100000\n max_cache_memory\n 1.4.5\n \n \n \n (...output omitted...)\n\n \n \n \n \n 1024\n integer\n system\n false\n The backlog queue limit.\n 1-10000\n backlog_queue_limit\n 1.4.5\n \n \n (...output omitted...)\n \n \n \n \n 0c507368-b7fe-11e0-9326-b7275b9d4a6c\n \n\n \n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters", "py_input_token": "marker" } }, "DescribeCacheSecurityGroups": { "name": "DescribeCacheSecurityGroups", "input": { "shape_name": "DescribeCacheSecurityGroupsMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group to return details for.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeCacheSecurityGroups operation.

\n " }, "output": { "shape_name": "CacheSecurityGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroups", "type": "list", "members": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the cache security group owner.

\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache security group.

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the Amazon EC2 security group owner.

\n " } }, "documentation": "\n

Provides ownership and status information for an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

A list of Amazon EC2 security groups that are associated with this cache security group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security groups. Each element in the list contains detailed information about one group.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheSecurityGroups operation.

\n " }, "errors": [ { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeCacheSecurityGroups operation returns a list of cache security group\n descriptions. If a cache security group name is specified, the list will contain only the\n description of that group.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeCacheSecurityGroups\n &Version=2013-06-15\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T01%3A22%3A48.381Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n \n default\n 123456789012\n default\n \n \n \n mycachesecuritygroup\n 123456789012\n My Security Group\n \n \n \n \n a95360ae-b7fc-11e0-9326-b7275b9d4a6c\n \n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSecurityGroups", "py_input_token": "marker" } }, "DescribeCacheSubnetGroups": { "name": "DescribeCacheSubnetGroups", "input": { "shape_name": "DescribeCacheSubnetGroupsMessage", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group to return details for.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeCacheSubnetGroups operation.

\n " }, "output": { "shape_name": "CacheSubnetGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "CacheSubnetGroups": { "shape_name": "CacheSubnetGroups", "type": "list", "members": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group.

\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache subnet group.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the subnet

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the availability zone.

\n " } }, "wrapper": true, "documentation": "\n

The Availability Zone associated with the subnet

\n " } }, "documentation": "\n

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

\n ", "xmlname": "Subnet" }, "documentation": "\n

A list of subnets associated with the cache subnet group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n ", "xmlname": "CacheSubnetGroup" }, "documentation": "\n

A list of cache subnet groups. Each element in the list contains detailed information about one group.

\n " } }, "documentation": "\n

Represents the output of a DescribeCacheSubnetGroups operation.

\n " }, "errors": [ { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group name does not refer to an existing cache subnet group.

\n " } ], "documentation": "\n

The DescribeCacheSubnetGroups operation returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list will contain only the\n description of that group.

\n \n Some of the output has been omitted for brevity. \n https://elasticache.amazonaws.com/\n ?Action=DescribeCacheSubnetGroups\n &Version=2013-06-15\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A40%3A19.926Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 990524496922\n description\n subnet_grp1\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n (...output omitted...)\n \n \n \n \n 31d0faee-229b-11e1-81f1-df3a2a803dad\n \n \n \n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSubnetGroups", "py_input_token": "marker" } }, "DescribeEngineDefaultParameters": { "name": "DescribeEngineDefaultParameters", "input": { "shape_name": "DescribeEngineDefaultParametersMessage", "type": "structure", "members": { "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6

\n ", "required": true }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeEngineDefaultParameters operation.

\n " }, "output": { "shape_name": "EngineDefaultsWrapper", "type": "structure", "members": { "EngineDefaults": { "shape_name": "EngineDefaults", "type": "structure", "members": { "CacheParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the cache parameter group family to which the engine default\n parameters apply.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \n

Provides an identifier to allow retrieval of paginated results.

\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

The value of the parameter.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the parameter.

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

The source of the parameter.

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

The valid data type for the parameter.

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

The valid range of values for the parameter.

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The earliest cache engine version to which the parameter can apply.

\n " } }, "documentation": "\n

Describes an individual setting that controls some aspect of ElastiCache behavior.

\n ", "xmlname": "Parameter" }, "documentation": "\n

Contains a list of engine default parameters.

\n " }, "CacheNodeTypeSpecificParameters": { "shape_name": "CacheNodeTypeSpecificParametersList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificParameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the parameter.

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

The source of the parameter value.

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

The valid data type for the parameter.

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

The valid range of values for the parameter.

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The earliest cache engine version to which the parameter can apply.

\n " }, "CacheNodeTypeSpecificValues": { "shape_name": "CacheNodeTypeSpecificValueList", "type": "list", "members": { "shape_name": "CacheNodeTypeSpecificValue", "type": "structure", "members": { "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type for which this value applies.

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

The value for the cache node type.

\n " } }, "documentation": "\n

A value that applies only to a certain cache node type.

\n ", "xmlname": "CacheNodeTypeSpecificValue" }, "documentation": "\n

A list of cache node types and their corresponding values for this parameter.

\n " } }, "documentation": "\n

A parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.

\n ", "xmlname": "CacheNodeTypeSpecificParameter" }, "documentation": "\n

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of a DescribeEngineDefaultParameters operation.

\n " } } }, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeEngineDefaultParameters operation returns the default engine and\n system parameter information for the specified cache engine.

\n \n Some of the output has been omitted for brevity. \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=DescribeEngineDefaultParameters\n &CacheParameterGroupFamily=memcached1.4\n &MaxRecords=100\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T01%3A34%3A31.045Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n memcached1.4\n \n \n 1024\n integer\n system\n false\n The backlog queue limit.\n 1-10000\n backlog_queue_limit\n 1.4.5\n \n \n \n (...output omitted...)\n \n \n \n \n \n \n \n cache.c1.xlarge\n 6000\n \n \n (...output omitted...)\n \n \n integer\n system\n false\n The maximum configurable amount of memory to use to store\n items, in megabytes.\n 1-100000\n max_cache_memory\n 1.4.5\n \n \n (...output omitted...)\n \n \n \n \n \n 061282fe-b7fd-11e0-9326-b7275b9d4a6c\n \n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults", "py_input_token": "marker" } }, "DescribeEvents": { "name": "DescribeEvents", "input": { "shape_name": "DescribeEventsMessage", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the event source for which events will be returned. If not specified,\n then all sources are included in the response.

\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group" ], "documentation": "\n

The event source to retrieve events for. If no value is specified, all events are\n returned.

\n

Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n

\n " }, "EndTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n

\n " }, "Duration": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of minutes' worth of events to retrieve.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeEvents operation.

\n " }, "output": { "shape_name": "EventsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "Events": { "shape_name": "EventList", "type": "list", "members": { "shape_name": "Event", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the source of the event. For example, if the event occurred at the\n cache cluster level, the identifier would be the name of the cache cluster.

\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group" ], "documentation": "\n

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The text of the event.

\n " }, "Date": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time when the event occurred.

\n " } }, "documentation": "\n

Represents a single occurrence of something interesting within the system. Some examples\n of events are creating a cache cluster, adding or removing a cache node, or rebooting a\n node.

\n ", "xmlname": "Event" }, "documentation": "\n

A list of events. Each element in the list contains detailed information about one event.

\n " } }, "documentation": "\n

Represents the output of a DescribeEvents operation.

\n " }, "errors": [ { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeEvents operation returns events related to cache clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cache cluster, cache security group, or cache parameter group by providing\n the name as a parameter.

\n

By default, only the events occurring within the last hour are returned; however, you\n can retrieve up to 14 days' worth of events if necessary.

\n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events", "py_input_token": "marker" } }, "DescribeReplicationGroups": { "name": "DescribeReplicationGroups", "input": { "shape_name": "DescribeReplicationGroupsMessage", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group to be described. This parameter is not case sensitive.

\n

If you do not specify this parameter, information about all replication groups is returned.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeReplicationGroups operation.

\n " }, "output": { "shape_name": "ReplicationGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n \n " }, "ReplicationGroups": { "shape_name": "ReplicationGroupList", "type": "list", "members": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the replication group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during\n the next maintenance window.

\n " } }, "documentation": "\n

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\n

The names of all the cache clusters that are part of this replication group.

\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the cache cluster to which the node belongs.

\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the node is located.

\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\n

The role that is currently assigned to the node - primary or replica.

\n " } }, "documentation": "\n

Represents a single node within a node group.

\n ", "xmlname": "NodeGroupMember" }, "documentation": "\n

A list containing information about individual nodes within the node group.

\n " } }, "documentation": "\n

Represents a collection of cache nodes in a replication group.

\n ", "xmlname": "NodeGroup" }, "documentation": "\n

A single element list with information about the nodes in the replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific replication group.

\n ", "xmlname": "ReplicationGroup" }, "documentation": "\n

A list of replication groups. Each item in the list contains detailed information about one replication group.

\n " } }, "documentation": "\n

Represents the output of a DescribeReplicationGroups operation.

\n " }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified replication group does not exist.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeReplicationGroups operation returns information about a particular\n replication group. If no identifier is specified, DescribeReplicationGroups\n returns information about all replication groups.

\n " }, "DescribeReservedCacheNodes": { "name": "DescribeReservedCacheNodes", "input": { "shape_name": "DescribeReservedCacheNodesMessage", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.

\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.

\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\n

The duration filter value, specified in years or seconds. Use this parameter to show\n only reservations for this duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The product description filter value. Use this parameter to show only those\n reservations matching the specified product description.

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeReservedCacheNodes operation.

\n " }, "output": { "shape_name": "ReservedCacheNodeMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": " \n

Provides an identifier to allow retrieval of paginated results.

\n " }, "ReservedCacheNodes": { "shape_name": "ReservedCacheNodeList", "type": "list", "members": { "shape_name": "ReservedCacheNode", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the reservation.

\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The offering identifier.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type for the reserved cache nodes.

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The time the reservation started.

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The duration of the reservation in seconds.

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The fixed price charged for this reserved cache node.

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The hourly price charged for this reserved cache node.

\n " }, "CacheNodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of cache nodes that have been reserved.

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the reserved cache node.

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The offering type of this reserved cache node.

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

The state of the reserved cache node.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The monetary amount of the recurring charge.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency of the recurring charge.

\n " } }, "wrapper": true, "documentation": "\n

Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The recurring price charged to run this reserved cache node.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of a PurchaseReservedCacheNodesOffering operation.

\n ", "xmlname": "ReservedCacheNode" }, "documentation": "\n

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

\n " } }, "documentation": "\n

Represents the output of a DescribeReservedCacheNodes operation.

\n " }, "errors": [ { "shape_name": "ReservedCacheNodeNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested reserved cache node was not found.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified\n reserved cache node.

\n \n https://elasticache.amazonaws.com/\n ?Action=DescribeReservedCacheNodes\n &ReservedCacheNodeId=customerSpecifiedID\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2012-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n Medium Utilization\n \n memcached\n 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f\n payment-failed\n myreservationid\n 1\n 2010-12-15T00:25:14.131Z\n 31536000\n 227.5\n 0.046\n cache.m1.small\n \n \n \n c695119b-2961-11e1-bd06-6fe008f046c3\n \n\n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodes", "py_input_token": "marker" } }, "DescribeReservedCacheNodesOfferings": { "name": "DescribeReservedCacheNodesOfferings", "input": { "shape_name": "DescribeReservedCacheNodesOfferingsMessage", "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type filter value. Use this parameter to show only the available\n offerings matching the specified cache node type.

\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\n

Duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.

\n

Valid Values: 1 | 3 | 31536000 | 94608000

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The offering type filter value. Use this parameter to show only the available\n offerings matching the specified offering type.

\n

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": " \n

The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.

\n

Default: 100

Constraints: minimum 20; maximum 100.

\n\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.

\n \n " } }, "documentation": "\n

Represents the input of a DescribeReservedCacheNodesOfferings operation.

\n " }, "output": { "shape_name": "ReservedCacheNodesOfferingMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n \n

Provides an identifier to allow retrieval of paginated results.

\n\n " }, "ReservedCacheNodesOfferings": { "shape_name": "ReservedCacheNodesOfferingList", "type": "list", "members": { "shape_name": "ReservedCacheNodesOffering", "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

A unique identifier for the reserved cache node offering.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type for the reserved cache node.

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The duration of the offering. in seconds.

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The fixed price charged for this offering.

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The hourly price charged for this offering.

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The cache engine used by the offering.

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The offering type.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The monetary amount of the recurring charge.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency of the recurring charge.

\n " } }, "wrapper": true, "documentation": "\n

Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The recurring price charged to run this reserved cache node.

\n " } }, "wrapper": true, "documentation": "\n

Describes all of the attributes of a reserved cache node offering.

\n ", "xmlname": "ReservedCacheNodesOffering" }, "documentation": "\n

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

\n " } }, "documentation": "\n

Represents the output of a DescribeReservedCacheNodesOfferings operation.

\n " }, "errors": [ { "shape_name": "ReservedCacheNodesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache node offering does not exist.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.

\n \n https://elasticache.amazonaws.com/\n ?Action=DescribeReservedCacheNodesOfferings\n &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 31536000\n Heavy Utilization\n \n \n Hourly\n 0.123\n \n \n 162.0\n memcached\n 0.0\n SampleOfferingId\n cache.m1.small\n \n \n \n \n 521b420a-2961-11e1-bd06-6fe008f046c3\n \n\n\n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodesOfferings", "py_input_token": "marker" } }, "ModifyCacheCluster": { "name": "ModifyCacheCluster", "input": { "shape_name": "ModifyCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache cluster identifier. This value is stored as a lowercase string.

\n ", "required": true }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than\n the existing number of cache nodes, then more nodes will be added. If the value is less\n than the existing number of cache nodes, then cache nodes will be removed.

\n

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter\n to provide the IDs of the specific cache nodes to be removed.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes\n is less than the existing number of cache nodes. The number of cache node IDs supplied\n in this parameter must match the difference between the existing number of cache nodes\n in the cluster and the value of NumCacheNodes in the request.

\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\n

A list of cache security group names to authorize on this cache cluster. This change is\n asynchronously applied as soon as possible.

\n

This parameter can be used only with clusters that are created outside of an Amazon\n Virtual Private Cloud (VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".

\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n

Specifies the VPC Security Groups associated with the cache cluster.

\n

This parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (VPC).

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The weekly time range (in UTC) during which system maintenance can occur. Note that\n system maintenance may result in an outage. This change is made immediately. If you are\n moving this window to the current time, there must be at least 120 minutes between the\n current time and end of the window to ensure that pending changes are applied.

\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent.

\n The SNS topic owner must be same as the cache cluster owner. \n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to apply to this cache cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.

\n " }, "NotificationTopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.

\n

Valid values: active | inactive

\n " }, "ApplyImmediately": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, this parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the cache cluster.

\n

If false, then changes to the cache cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.

\n

Valid values: true | false

\n

Default: false

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The upgraded version of the cache engine to be run on the cache cluster nodes.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

If true, then minor engine upgrades will be applied automatically to the cache cluster\n during the maintenance window.

\n

Valid values: true | false

\n

Default: true

\n " } }, "documentation": "\n

Represents the input of a ModifyCacheCluster operation.

\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied identifier of the cache cluster. This is a unique key that identifies\n a cache cluster.

\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the web page where you can download the latest ElastiCache client library.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the compute and memory capacity node type for the cache cluster.

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine (memcached or redis) to be used for this cache cluster.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the cache engine version that is used in this cache cluster.

\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache cluster - creating, available, etc.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes in the cache cluster.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the cache cluster is located.

\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache cluster was created.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The time range (in UTC) during which weekly system maintenance can occur.

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The new number of cache nodes for the cache cluster.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The new cache engine version that the cache cluster will run.

\n " } }, "documentation": "\n

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) that identifies the topic.

\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of the topic.

\n " } }, "documentation": "\n

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a cache cluster's status within a particular cache security group.

\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security group elements, composed of name and status sub-elements.

\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of parameter updates.

\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

\n " } }, "documentation": "\n

The status of the cache parameter group.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group associated with the cache cluster.

\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.

\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache node.

\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache node was created.

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

The hostname and IP address for connecting to this cache node.

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the parameter group applied to this cache node.

\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this\n node is not associated with a primary cache cluster.

\n " } }, "documentation": "\n

Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n ", "xmlname": "CacheNode" }, "documentation": "\n

A list of cache nodes that are members of the cache cluster.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupMembershipList", "type": "list", "members": { "shape_name": "SecurityGroupMembership", "type": "structure", "members": { "SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a single cache security group and its status..

\n " }, "documentation": "\n

A list of VPC Security Groups associated with the cache cluster.

\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific cache cluster.

\n " } } }, "errors": [ { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster is not in the available state.

\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache security group does not allow deletion.

\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " }, { "shape_name": "NodeQuotaForClusterExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed\n number of cache nodes in a single cache cluster.

\n " }, { "shape_name": "NodeQuotaForCustomerExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.\n

\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

The VPC network is in an invalid state.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The ModifyCacheCluster operation modifies the settings for a cache cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=ModifyCacheCluster\n &NumCacheNodes=5\n &CacheClusterId=simcoprod01\n &Version=2013-06-15\n &ApplyImmediately=true\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T03%3A16%3A34.601Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n in-sync\n default.memcached1.4\n \n \n simcoprod01\n available\n \n 11211\n
simcoprod01.m2st2p.cfg.cache.amazonaws.com
\n \n cache.m1.large\n memcached\n \n 5\n \n us-east-1b\n 2011-07-26T23:45:20.937Z\n 1.4.5\n true\n fri:04:30-fri:05:00\n \n \n default\n active\n \n \n 3\n \n \n \n d5786c6d-b7fe-11e0-9326-b7275b9d4a6c\n \n\n \n " }, "ModifyCacheParameterGroup": { "name": "ModifyCacheParameterGroup", "input": { "shape_name": "ModifyCacheParameterGroupMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to modify.

\n ", "required": true }, "ParameterNameValues": { "shape_name": "ParameterNameValueList", "type": "list", "members": { "shape_name": "ParameterNameValue", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

The value of the parameter.

\n " } }, "documentation": "\n

Describes a name-value pair that is used to update the value of a parameter.

\n ", "xmlname": "ParameterNameValue" }, "documentation": "\n

An array of parameter names and values for the parameter update. You must supply at least one parameter\n name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.

\n ", "required": true } }, "documentation": "\n

Represents the input of a ModifyCacheParameterGroup operation.

\n " }, "output": { "shape_name": "CacheParameterGroupNameMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " } }, "documentation": "\n

Represents the output of one of the following operations:

\n \n " }, "errors": [ { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache parameter group does not allow the requested action to\n occur.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The ModifyCacheParameterGroup operation modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=ModifyCacheParameterGroup\n ?ParameterNameValues.member.1.ParameterName=chunk_size_growth_factor\n &ParameterNameValues.member.1.ParameterValue=1.02\n &CacheParameterGroupName=mycacheparametergroup\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T03%3A24%3A50.203Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n mycacheparametergroup\n \n \n fcedeef2-b7ff-11e0-9326-b7275b9d4a6c\n \n\n \n \n " }, "ModifyCacheSubnetGroup": { "name": "ModifyCacheSubnetGroup", "input": { "shape_name": "ModifyCacheSubnetGroupMessage", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name for the cache subnet group. This value is stored as a lowercase string.

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

\n

Example: mysubnetgroup

\n ", "required": true }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

A description for the cache subnet group.

\n " }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

The EC2 subnet IDs for the cache subnet group.

\n " } }, "documentation": "\n

Represents the input of a ModifyCacheSubnetGroup operation.

\n " }, "output": { "shape_name": "CacheSubnetGroupWrapper", "type": "structure", "members": { "CacheSubnetGroup": { "shape_name": "CacheSubnetGroup", "type": "structure", "members": { "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group.

\n " }, "CacheSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache subnet group.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the subnet

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the availability zone.

\n " } }, "wrapper": true, "documentation": "\n

The Availability Zone associated with the subnet

\n " } }, "documentation": "\n

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

\n ", "xmlname": "Subnet" }, "documentation": "\n

A list of subnets associated with the cache subnet group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n " } } }, "errors": [ { "shape_name": "CacheSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache subnet group name does not refer to an existing cache subnet group.

\n " }, { "shape_name": "CacheSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet\n group.

\n " }, { "shape_name": "SubnetInUse", "type": "structure", "members": {}, "documentation": "\n

The requested subnet is being used by another cache subnet group.

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

An invalid subnet identifier was specified.

\n " } ], "documentation": "\n

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.

\n \n https://elasticache.amazonaws.com/\n ?Action=ModifyCacheSubnetGroup\n &CacheSubnetGroupName=myCachesubnetgroup\n &CacheSubnetGroupDescription=My%20modified%20CacheSubnetGroup\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 990524496922\n My modified CacheSubnetGroup\n myCachesubnetgroup\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n \n " }, "ModifyReplicationGroup": { "name": "ModifyReplicationGroup", "input": { "shape_name": "ModifyReplicationGroupMessage", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the replication group to modify.

\n ", "required": true }, "ReplicationGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

A description for the replication group. Maximum length is 255 characters.

\n " }, "CacheSecurityGroupNames": { "shape_name": "CacheSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheSecurityGroupName" }, "documentation": "\n

A list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.

\n

This parameter can be used only with replication groups containing cache clusters running outside of an Amazon\n Virtual Private Cloud (VPC).

\n

Constraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".

\n " }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

\n

This parameter can be used only with replication groups containing cache clusters running in an Amazon Virtual\n Private Cloud (VPC).

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The weekly time range (in UTC) during which replication group system maintenance can occur. Note that\n system maintenance may result in an outage. This change is made immediately. If you are\n moving this window to the current time, there must be at least 120 minutes between the\n current time and end of the window to ensure that pending changes are applied.

\n " }, "NotificationTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the SNS topic to which notifications will be sent.

\n The SNS topic owner must be same as the replication group owner. \n " }, "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to apply to all of the cache nodes in this replication group. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.

\n " }, "NotificationTopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon SNS notification topic for the replication group. Notifications\n are sent only if the status is active.

\n

Valid values: active | inactive

\n " }, "ApplyImmediately": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, this parameter causes the modifications in this request and any pending modifications\n to be applied, asynchronously and as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the replication group.

\n

If false, then changes to the nodes in the replication group are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.

\n

Valid values: true | false

\n

Default: false

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The upgraded version of the cache engine to be run on the nodes in the replication group..

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

Determines whether minor engine upgrades will be applied automatically to all of the\n cache nodes in the replication group during the maintenance window. A value of\n true allows these upgrades to occur; false disables\n automatic upgrades.

\n " }, "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

If this parameter is specified, ElastiCache will promote each of the nodes in the specified cache cluster to the primary role. The nodes of all other clusters in the replication group will be read replicas.

\n " } }, "documentation": "\n

Represents the input of a ModifyReplicationGroups operation.

\n " }, "output": { "shape_name": "ReplicationGroupWrapper", "type": "structure", "members": { "ReplicationGroup": { "shape_name": "ReplicationGroup", "type": "structure", "members": { "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the replication group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the replication group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PendingModifiedValues": { "shape_name": "ReplicationGroupPendingModifiedValues", "type": "structure", "members": { "PrimaryClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during\n the next maintenance window.

\n " } }, "documentation": "\n

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

\n " }, "MemberClusters": { "shape_name": "ClusterIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterId" }, "documentation": "\n

The names of all the cache clusters that are part of this replication group.

\n " }, "NodeGroups": { "shape_name": "NodeGroupList", "type": "list", "members": { "shape_name": "NodeGroup", "type": "structure", "members": { "NodeGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this replication group - creating, available, etc.

\n " }, "PrimaryEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "NodeGroupMembers": { "shape_name": "NodeGroupMemberList", "type": "list", "members": { "shape_name": "NodeGroupMember", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the cache cluster to which the node belongs.

\n " }, "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "ReadEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the node is located.

\n " }, "CurrentRole": { "shape_name": "String", "type": "string", "documentation": "\n

The role that is currently assigned to the node - primary or replica.

\n " } }, "documentation": "\n

Represents a single node within a node group.

\n ", "xmlname": "NodeGroupMember" }, "documentation": "\n

A list containing information about individual nodes within the node group.

\n " } }, "documentation": "\n

Represents a collection of cache nodes in a replication group.

\n ", "xmlname": "NodeGroup" }, "documentation": "\n

A single element list with information about the nodes in the replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific replication group.

\n " } } }, "errors": [ { "shape_name": "ReplicationGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified replication group does not exist.

\n " }, { "shape_name": "InvalidReplicationGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested replication group is not in the available state.

\n " }, { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster is not in the available state.

\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache security group does not allow deletion.

\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " }, { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

The VPC network is in an invalid state.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The ModifyReplicationGroup operation modifies the settings for a replication group.

\n " }, "PurchaseReservedCacheNodesOffering": { "name": "PurchaseReservedCacheNodesOffering", "input": { "shape_name": "PurchaseReservedCacheNodesOfferingMessage", "type": "structure", "members": { "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the reserved cache node offering to purchase.

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

\n ", "required": true }, "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

A customer-specified identifier to track this reservation.

\n

Example: myreservationID

\n " }, "CacheNodeCount": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache node instances to reserve.

\n

Default: 1

\n " } }, "documentation": "\n

Represents the input of a PurchaseReservedCacheNodesOffering operation.

\n " }, "output": { "shape_name": "ReservedCacheNodeWrapper", "type": "structure", "members": { "ReservedCacheNode": { "shape_name": "ReservedCacheNode", "type": "structure", "members": { "ReservedCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the reservation.

\n " }, "ReservedCacheNodesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The offering identifier.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node type for the reserved cache nodes.

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The time the reservation started.

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The duration of the reservation in seconds.

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The fixed price charged for this reserved cache node.

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

The hourly price charged for this reserved cache node.

\n " }, "CacheNodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of cache nodes that have been reserved.

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the reserved cache node.

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The offering type of this reserved cache node.

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

The state of the reserved cache node.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The monetary amount of the recurring charge.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency of the recurring charge.

\n " } }, "wrapper": true, "documentation": "\n

Contains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The recurring price charged to run this reserved cache node.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of a PurchaseReservedCacheNodesOffering operation.

\n " } } }, "errors": [ { "shape_name": "ReservedCacheNodesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache node offering does not exist.

\n " }, { "shape_name": "ReservedCacheNodeAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

This user already has a reservation with the given identifier.

\n " }, { "shape_name": "ReservedCacheNodeQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The request cannot be processed because it would exceed the user's cache node quota.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.

\n \n https://elasticache.amazonaws.com/\n ?Action=PurchaseReservedCacheNodesOffering\n &ReservedCacheNodeId=myreservationID\n &ReservedCacheNodesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &CacheNodeCount=1\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-10T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n Medium Utilization\n \n memcached\n 438012d3-4052-4cc7-b2e3-8d3372e0e706\n payment-pending\n myreservationID\n 10\n 2011-12-18T23:24:56.577Z\n 31536000\n 123.0\n 0.123\n cache.m1.small\n \n \n \n 7f099901-29cf-11e1-bd06-6fe008f046c3\n \n\n\n \n " }, "RebootCacheCluster": { "name": "RebootCacheCluster", "input": { "shape_name": "RebootCacheClusterMessage", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache cluster identifier. This parameter is stored as a lowercase string.

\n ", "required": true }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache cluster node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify\n all of the cache cluster node IDs.

\n ", "required": true } }, "documentation": "\n

Represents the input of a RebootCacheCluster operation.

\n " }, "output": { "shape_name": "CacheClusterWrapper", "type": "structure", "members": { "CacheCluster": { "shape_name": "CacheCluster", "type": "structure", "members": { "CacheClusterId": { "shape_name": "String", "type": "string", "documentation": "\n

The user-supplied identifier of the cache cluster. This is a unique key that identifies\n a cache cluster.

\n " }, "ConfigurationEndpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

Represents the information required for client programs to connect to a cache node.

\n " }, "ClientDownloadLandingPage": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the web page where you can download the latest ElastiCache client library.

\n " }, "CacheNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the compute and memory capacity node type for the cache cluster.

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache engine (memcached or redis) to be used for this cache cluster.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the cache engine version that is used in this cache cluster.

\n " }, "CacheClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache cluster - creating, available, etc.

\n " }, "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of cache nodes in the cache cluster.

\n " }, "PreferredAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Availability Zone in which the cache cluster is located.

\n " }, "CacheClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache cluster was created.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

The time range (in UTC) during which weekly system maintenance can occur.

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "NumCacheNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The new number of cache nodes for the cache cluster.

\n " }, "CacheNodeIdsToRemove": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The new cache engine version that the cache cluster will run.

\n " } }, "documentation": "\n

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

\n " }, "NotificationConfiguration": { "shape_name": "NotificationConfiguration", "type": "structure", "members": { "TopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) that identifies the topic.

\n " }, "TopicStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of the topic.

\n " } }, "documentation": "\n

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

\n " }, "CacheSecurityGroups": { "shape_name": "CacheSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "CacheSecurityGroupMembership", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a cache cluster's status within a particular cache security group.

\n ", "xmlname": "CacheSecurityGroup" }, "documentation": "\n

A list of cache security group elements, composed of name and status sub-elements.

\n " }, "CacheParameterGroup": { "shape_name": "CacheParameterGroupStatus", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of parameter updates.

\n " }, "CacheNodeIdsToReboot": { "shape_name": "CacheNodeIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "CacheNodeId" }, "documentation": "\n

A list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).

\n " } }, "documentation": "\n

The status of the cache parameter group.

\n " }, "CacheSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache subnet group associated with the cache cluster.

\n " }, "CacheNodes": { "shape_name": "CacheNodeList", "type": "list", "members": { "shape_name": "CacheNode", "type": "structure", "members": { "CacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.

\n " }, "CacheNodeStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The current state of this cache node.

\n " }, "CacheNodeCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the cache node was created.

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

The DNS hostname of the cache node.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port number that the cache engine is listening on.

\n " } }, "documentation": "\n

The hostname and IP address for connecting to this cache node.

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the parameter group applied to this cache node.

\n " }, "SourceCacheNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this\n node is not associated with a primary cache cluster.

\n " } }, "documentation": "\n

Represents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.

\n ", "xmlname": "CacheNode" }, "documentation": "\n

A list of cache nodes that are members of the cache cluster.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.

\n " }, "SecurityGroups": { "shape_name": "SecurityGroupMembershipList", "type": "list", "members": { "shape_name": "SecurityGroupMembership", "type": "structure", "members": { "SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the cache security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.

\n " } }, "documentation": "\n

Represents a single cache security group and its status..

\n " }, "documentation": "\n

A list of VPC Security Groups associated with the cache cluster.

\n " }, "ReplicationGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.

\n " } }, "wrapper": true, "documentation": "\n

Contains all of the attributes of a specific cache cluster.

\n " } } }, "errors": [ { "shape_name": "InvalidCacheClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster is not in the available state.

\n " }, { "shape_name": "CacheClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested cache cluster ID does not refer to an existing cache cluster.

\n " } ], "documentation": "\n

The RebootCacheCluster operation reboots some, or all, of the cache cluster nodes\n within a provisioned cache cluster. This API will apply any modified cache parameter\n groups to the cache cluster. The reboot action takes place as soon as possible, and\n results in a momentary outage to the cache cluster. During the reboot, the cache cluster\n status is set to REBOOTING.

\n

The reboot causes the contents of the cache (for each cache cluster node being rebooted)\n to be lost.

\n

When the reboot is complete, a cache cluster event is created.

\n " }, "ResetCacheParameterGroup": { "name": "ResetCacheParameterGroup", "input": { "shape_name": "ResetCacheParameterGroupMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group to reset.

\n ", "required": true }, "ResetAllParameters": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, all parameters in the cache parameter group will be reset to default\n values. If false, no such action occurs.

\n

Valid values: true | false

\n " }, "ParameterNameValues": { "shape_name": "ParameterNameValueList", "type": "list", "members": { "shape_name": "ParameterNameValue", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the parameter.

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

The value of the parameter.

\n " } }, "documentation": "\n

Describes a name-value pair that is used to update the value of a parameter.

\n ", "xmlname": "ParameterNameValue" }, "documentation": "\n

An array of parameter names to be reset. If you are not resetting the entire\n cache parameter group, you must specify at least one parameter name.

\n ", "required": true } }, "documentation": "\n

Represents the input of a ResetCacheParameterGroup operation.

\n " }, "output": { "shape_name": "CacheParameterGroupNameMessage", "type": "structure", "members": { "CacheParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache parameter group.

\n " } }, "documentation": "\n

Represents the output of one of the following operations:

\n \n " }, "errors": [ { "shape_name": "InvalidCacheParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache parameter group does not allow the requested action to\n occur.

\n " }, { "shape_name": "CacheParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache parameter group name does not refer to an existing cache parameter group.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The ResetCacheParameterGroup operation modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the ResetAllParameters and CacheParameterGroupName parameters.

\n " }, "RevokeCacheSecurityGroupIngress": { "name": "RevokeCacheSecurityGroupIngress", "input": { "shape_name": "RevokeCacheSecurityGroupIngressMessage", "type": "structure", "members": { "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group to revoke ingress from.

\n ", "required": true }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 security group to revoke access from.

\n ", "required": true }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same\n thing as an AWS access key ID - you must provide a valid AWS account number for this\n parameter.

\n ", "required": true } }, "documentation": "\n

Represents the input of a RevokeCacheSecurityGroupIngress operation.

\n " }, "output": { "shape_name": "CacheSecurityGroupWrapper", "type": "structure", "members": { "CacheSecurityGroup": { "shape_name": "CacheSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the cache security group owner.

\n " }, "CacheSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cache security group.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

The description of the cache security group.

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 security group.

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account ID of the Amazon EC2 security group owner.

\n " } }, "documentation": "\n

Provides ownership and status information for an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

A list of Amazon EC2 security groups that are associated with this cache security group.

\n " } }, "wrapper": true, "documentation": "\n

Represents the output of one of the following operations:

\n \n " } } }, "errors": [ { "shape_name": "CacheSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The requested cache security group name does not refer to an existing cache security group.

\n " }, { "shape_name": "AuthorizationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified Amazon EC2 security group is not authorized for the specified cache security\n group.

\n " }, { "shape_name": "InvalidCacheSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

The current state of the cache security group does not allow deletion.

\n " }, { "shape_name": "InvalidParameterValueException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

A parameter value is invalid.

\n " } }, "documentation": "\n

The value for a parameter is invalid.

\n " }, { "shape_name": "InvalidParameterCombinationException", "type": "structure", "members": { "message": { "shape_name": "AwsQueryErrorMessage", "type": "string", "documentation": "\n

Two or more parameters that must not be used together were used together.

\n " } }, "documentation": "\n

Two or more incompatible parameters were specified.

\n " } ], "documentation": "\n

The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache\n security group. Use this operation to disallow access from an Amazon EC2 security group that\n had been previously authorized.

\n \n \nhttps://elasticache.us-east-1.amazonaws.com/\n ?Action=RevokeCacheSecurityGroupIngress\n &EC2SecurityGroupName=default\n &CacheSecurityGroupName=mygroup\n &EC2SecurityGroupOwnerId=1234-5678-1234\n &Version=2013-06-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-07-27T02%3A30%3A08.444Z\n &AWSAccessKeyId=YOUR-ACCESS-KEY\n &Signature=YOUR-SIGNATURE\n \n\n \n \n \n \n revoking\n default\n 123456781234\n \n \n mygroup\n 123456789012\n My security group\n \n \n \n 02ae3699-3650-11e0-a564-8f11342c56b0\n \n\n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://elasticache.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "DescribeCacheClusters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheClusters", "py_input_token": "marker" }, "DescribeCacheEngineVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheEngineVersions", "py_input_token": "marker" }, "DescribeCacheParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheParameterGroups", "py_input_token": "marker" }, "DescribeCacheParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters", "py_input_token": "marker" }, "DescribeCacheSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSecurityGroups", "py_input_token": "marker" }, "DescribeCacheSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSubnetGroups", "py_input_token": "marker" }, "DescribeEngineDefaultParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults", "py_input_token": "marker" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events", "py_input_token": "marker" }, "DescribeReservedCacheNodes": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodes", "py_input_token": "marker" }, "DescribeReservedCacheNodesOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodesOfferings", "py_input_token": "marker" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/elasticbeanstalk.json0000644000175000017500000113126412254746564022462 0ustar takakitakaki{ "api_version": "2010-12-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "AWS Elastic Beanstalk", "service_abbreviation": "Elastic Beanstalk", "endpoint_prefix": "elasticbeanstalk", "xmlnamespace": "http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/", "documentation": "\n AWS Elastic Beanstalk\n\n

\n This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information \n about AWS Elastic Beanstalk actions, data types, parameters, and errors.\n

\n\n

AWS Elastic Beanstalk\n is a tool that makes it easy for you to create,\n deploy, and manage scalable, fault-tolerant applications running on\n Amazon Web Services cloud resources.\n

\n\n

\n For more information about this product, go to the AWS Elastic Beanstalk details page. \n The location of the lastest AWS Elastic Beanstalk WSDL is \n http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.\n

\n

Endpoints

\n

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the \nAmazon Web Services Glossary.

\n ", "operations": { "CheckDNSAvailability": { "name": "CheckDNSAvailability", "input": { "shape_name": "CheckDNSAvailabilityMessage", "type": "structure", "members": { "CNAMEPrefix": { "shape_name": "DNSCnamePrefix", "type": "string", "min_length": 4, "max_length": 63, "documentation": "\n

\n The prefix used when this CNAME is reserved.\n\t\t

\n ", "required": true } }, "documentation": "\n

Results message indicating whether a CNAME is available.

\n " }, "output": { "shape_name": "CheckDNSAvailabilityResultMessage", "type": "structure", "members": { "Available": { "shape_name": "CnameAvailability", "type": "boolean", "documentation": "\n

\n Indicates if the specified CNAME is available:\n\t\t

\n \n \n

\n true\n : The CNAME is available.\n

\n \n \n

\n true\n : The CNAME is not available.\n

\n \n \n

\n

\n

\n " }, "FullyQualifiedCNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The fully qualified CNAME to reserve when CreateEnvironment is called\n with the provided prefix.

\n " } }, "documentation": "\n

Indicates if the specified CNAME is available.

\n " }, "errors": [], "documentation": "\n

\n Checks if the specified CNAME is available.\n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?CNAMEPrefix=sampleapplication\n&Operation=CheckDNSAvailability\n&AuthParams \n\n \n \n sampleapplication.elasticbeanstalk.amazonaws.com\n true\n \n \n 12f6701f-f1d6-11df-8a78-9f77047e0d0c\n \n\n \n\n " }, "CreateApplication": { "name": "CreateApplication", "input": { "shape_name": "CreateApplicationMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application.

\n

\n Constraint: This name must be unique within your account.\n If the\n specified name already exists, the action returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes the application.

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "ApplicationDescriptionMessage", "type": "structure", "members": { "Application": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

User-defined description of the application.

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The date when the application was created.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The date when the application was last modified.

\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

The names of the versions for this application.

\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n The names of the configuration templates associated with this\n application.\n\t

\n " } }, "documentation": "\n

\n The\n ApplicationDescription\n of the application.\n

\n " } }, "documentation": "\n

Result message containing a single description of an application.

\n " }, "errors": [ { "shape_name": "TooManyApplicationsException", "type": "structure", "members": {}, "documentation": "\n

The caller has exceeded the limit on the number of applications associated with their account.

\n " } ], "documentation": "\n

\n Creates an application that has one configuration\n template named\n default\n and no application versions.\n

\n \n The\n default\n configuration template is for a 32-bit version of the\n Amazon Linux\n operating system running the Tomcat 6 application container.\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&Description=Sample%20Description\n&Operation=CreateApplication\n&AuthParams \n\n \n \n \n \n Sample Description\n SampleApp\n 2010-11-16T23:09:20.256Z\n 2010-11-16T23:09:20.256Z\n \n Default\n \n \n \n \n 8b00e053-f1d6-11df-8a78-9f77047e0d0c\n \n \n \n " }, "CreateApplicationVersion": { "name": "CreateApplicationVersion", "input": { "shape_name": "CreateApplicationVersionMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application.\n If no application is found with this name,\n and\n AutoCreateApplication\n is\n false, returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

A label identifying this version.

\n

Constraint:\n Must be unique per application. If an application version already\n exists with this label for the specified application, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this version.

\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\n

The Amazon S3 bucket where the data is located.

\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\n

The Amazon S3 key where the data is located.

\n " } }, "documentation": "\n

The Amazon S3 bucket and key that identify the location of the\n source\n bundle for this version.

\n\n

\n If data found at the Amazon S3 location exceeds the maximum allowed\n source bundle size, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error. The maximum size allowed is 512 MB.\n

\n

Default:\n If not specified, AWS Elastic Beanstalk\n uses a sample application.\n If only partially specified (for example, a bucket is provided but not\n the key)\n or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n

\n " }, "AutoCreateApplication": { "shape_name": "AutoCreateApplication", "type": "boolean", "documentation": "\n

\n Determines how the system behaves if the specified\n application for this\n version does not already exist:\n

\n \n \n

\n true: Automatically creates the specified application for this\n version if it does not already exist.\n

\n \n \n

\n false: Returns an\n InvalidParameterValue\n if the specified application for this version does not already\n exist.\n

\n \n \n\n \n

\n Default:\n false\n

\n

\n Valid Values:\n true\n |\n false\n

\n\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ApplicationVersionDescriptionMessage", "type": "structure", "members": { "ApplicationVersion": { "shape_name": "ApplicationVersionDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this release.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

The description of this application version.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n A label uniquely identifying the version for the associated\n application.\n

\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\n

The Amazon S3 bucket where the data is located.

\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\n

The Amazon S3 key where the data is located.

\n " } }, "documentation": "\n

\n The location where the source bundle is located for this version.\n\t

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date of the application version.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date of the application version.

\n " } }, "documentation": "\n

\n The\n ApplicationVersionDescription\n of the application version.\n

\n " } }, "documentation": "\n

\n Result message wrapping a single description of an application\n version.\n

\n " }, "errors": [ { "shape_name": "TooManyApplicationsException", "type": "structure", "members": {}, "documentation": "\n

The caller has exceeded the limit on the number of applications associated with their account.

\n " }, { "shape_name": "TooManyApplicationVersionsException", "type": "structure", "members": {}, "documentation": "\n

The caller has exceeded the limit on the number of application versions associated with their account.

\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " }, { "shape_name": "S3LocationNotInServiceRegionException", "type": "structure", "members": {}, "documentation": "\n

The specified S3 bucket does not belong to the S3 region in which the service is running.

\n " } ], "documentation": "\n

Creates an application version for the specified\n application.

\n Once you create an application version with a specified Amazon S3\n bucket\n and key location, you cannot change that Amazon S3 location. If you change the\n Amazon S3 location,\n you receive an exception when you attempt to launch an environment from the\n application version. \n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&VersionLabel=Version1\n&Description=description\n&SourceBundle.S3Bucket=amazonaws.com\n&SourceBundle.S3Key=sample.war\n&AutoCreateApplication=true\n&Operation=CreateApplicationVersion\n&AuthParams \n\n \n \n \n \n amazonaws.com\n sample.war\n \n Version1\n description\n SampleApp\n 2010-11-17T03:21:59.161Z\n 2010-11-17T03:21:59.161Z\n \n \n \n d653efef-f1f9-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "CreateConfigurationTemplate": { "name": "CreateConfigurationTemplate", "input": { "shape_name": "CreateConfigurationTemplateMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application to associate with this\n configuration\n template. If no application is found with this name, AWS Elastic Beanstalk returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the configuration template.

\n\n

Constraint: This name must be unique per\n application.

\n

Default:\n If a configuration template\n already exists with this name, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

The name of the solution stack used by this configuration. The solution\n stack specifies the operating system, architecture, and\n application\n server for a configuration template. It determines the set\n of\n configuration options as well as the possible and default values.\n

\n\n

\n Use\n ListAvailableSolutionStacks\n to obtain a list of available solution stacks.\n

\n

\n\t\t\t\t A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error. \n

\n

\n\t\t\t\t If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.\n

\n\n " }, "SourceConfiguration": { "shape_name": "SourceConfiguration", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with the configuration.

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the configuration template.

\n " } }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n uses the configuration values from the\n specified configuration template\n to create a new configuration.\n

\n

\n Values specified in the\n OptionSettings\n parameter of this call overrides any values obtained\n from the\n SourceConfiguration.\n

\n\n

\n If no configuration template is found, returns an\n InvalidParameterValue\n error.\n

\n

\n Constraint: If both the solution stack name parameter and the source\n configuration parameters are specified,\n the solution stack of the source\n configuration template must match the\n specified solution stack name or\n else AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the environment used with this configuration template.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this configuration.

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n sets the specified configuration option to the requested value.\n The new value overrides the value obtained from the solution stack\n or the source configuration template.\n

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack this configuration set uses.\n\t\t

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application associated with this configuration set.\n\t\t

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If not\n null, the name of the configuration template for this configuration set.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

\n Describes this configuration set.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n If not\n null, the name of the environment for this configuration set.\n

\n " }, "DeploymentStatus": { "shape_name": "ConfigurationDeploymentStatus", "type": "string", "enum": [ "deployed", "pending", "failed" ], "documentation": "\n

\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t

\n \n \n

\n null: This configuration is not associated with a running\n environment.\n

\n \n \n

\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n

\n \n \n

\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n

\n \n \n

\n failed: This is a draft configuration, that\n failed to successfully deploy.\n

\n \n \n\n \n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was created.\n\t\t

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was last modified.\n\t\t

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n A list of the configuration options and their values in this configuration\n set.\n\t\t

\n " } }, "documentation": "\n

\n Describes the settings for a configuration set.\n\t\t

\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " }, { "shape_name": "TooManyConfigurationTemplatesException", "type": "structure", "members": {}, "documentation": "\n

The caller has exceeded the limit on the number of configuration templates associated with their account.

\n " } ], "documentation": "\n

Creates a configuration template. Templates are associated with a\n specific application\n and are used to deploy different versions of the\n application with\n the same configuration settings.

\n\n

Related Topics

\n \n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&TemplateName=AppTemplate\n&SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207\n&Description=ConfigTemplateDescription\n&Operation=CreateConfigurationTemplate\n&AuthParams \n\n \n \n 32bit Amazon Linux running Tomcat 7\n \n \n ImageId\n ami-f2f0069b\n aws:autoscaling:launchconfiguration\n \n \n Notification Endpoint\n \n aws:elasticbeanstalk:sns:topics\n \n \n PARAM4\n \n aws:elasticbeanstalk:application:environment\n \n \n JDBC_CONNECTION_STRING\n \n aws:elasticbeanstalk:application:environment\n \n \n SecurityGroups\n elasticbeanstalk-default\n aws:autoscaling:launchconfiguration\n \n \n UnhealthyThreshold\n 5\n aws:elb:healthcheck\n \n \n InstanceType\n t1.micro\n aws:autoscaling:launchconfiguration\n \n \n Statistic\n Average\n aws:autoscaling:trigger\n \n \n LoadBalancerHTTPSPort\n OFF\n aws:elb:loadbalancer\n \n \n Stickiness Cookie Expiration\n 0\n aws:elb:policies\n \n \n PARAM5\n \n aws:elasticbeanstalk:application:environment\n \n \n MeasureName\n NetworkOut\n aws:autoscaling:trigger\n \n \n Interval\n 30\n aws:elb:healthcheck\n \n \n Application Healthcheck URL\n /\n aws:elasticbeanstalk:application\n \n \n Notification Topic ARN\n \n aws:elasticbeanstalk:sns:topics\n \n \n LowerBreachScaleIncrement\n -1\n aws:autoscaling:trigger\n \n \n XX:MaxPermSize\n 64m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n UpperBreachScaleIncrement\n 1\n aws:autoscaling:trigger\n \n \n MinSize\n 1\n aws:autoscaling:asg\n \n \n Custom Availability Zones\n us-east-1a\n aws:autoscaling:asg\n \n \n Availability Zones\n Any 1\n aws:autoscaling:asg\n \n \n LogPublicationControl\n false\n aws:elasticbeanstalk:hostmanager\n \n \n JVM Options\n \n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n Notification Topic Name\n \n aws:elasticbeanstalk:sns:topics\n \n \n PARAM2\n \n aws:elasticbeanstalk:application:environment\n \n \n LoadBalancerHTTPPort\n 80\n aws:elb:loadbalancer\n \n \n Timeout\n 5\n aws:elb:healthcheck\n \n \n BreachDuration\n 2\n aws:autoscaling:trigger\n \n \n MonitoringInterval\n 5 minute\n aws:autoscaling:launchconfiguration\n \n \n PARAM1\n \n aws:elasticbeanstalk:application:environment\n \n \n MaxSize\n 4\n aws:autoscaling:asg\n \n \n LowerThreshold\n 2000000\n aws:autoscaling:trigger\n \n \n AWS_SECRET_KEY\n \n aws:elasticbeanstalk:application:environment\n \n \n AWS_ACCESS_KEY_ID\n \n aws:elasticbeanstalk:application:environment\n \n \n UpperThreshold\n 6000000\n aws:autoscaling:trigger\n \n \n Notification Protocol\n email\n aws:elasticbeanstalk:sns:topics\n \n \n Unit\n Bytes\n aws:autoscaling:trigger\n \n \n Xmx\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n Cooldown\n 360\n aws:autoscaling:asg\n \n \n Period\n 1\n aws:autoscaling:trigger\n \n \n Xms\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n EC2KeyName\n \n aws:autoscaling:launchconfiguration\n \n \n Stickiness Policy\n false\n aws:elb:policies\n \n \n PARAM3\n \n aws:elasticbeanstalk:application:environment\n \n \n HealthyThreshold\n 3\n aws:elb:healthcheck\n \n \n SSLCertificateId\n \n aws:elb:loadbalancer\n \n \n ConfigTemplateDescription\n SampleApp\n 2010-11-17T03:48:19.640Z\n AppTemplate\n 2010-11-17T03:48:19.640Z\n \n \n 846cd905-f1fd-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "CreateEnvironment": { "name": "CreateEnvironment", "input": { "shape_name": "CreateEnvironmentMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application that contains the version to be deployed.\n

\n

\n If no application is found with this name, CreateEnvironment\n returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n A unique name for the deployment environment. Used in\n the application\n URL.\n

\n

Constraint: Must be from 4 to 23 characters\n in length. The name can\n contain only letters, numbers, and hyphens. It cannot start\n or end with\n a hyphen. This name must be unique in your account.\n If the specified\n name already exists, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n

Default: If the CNAME parameter is not specified, the environment name\n becomes part of the CNAME, and therefore\n part of the visible URL for your application.

\n\n\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this environment.

\n " }, "CNAMEPrefix": { "shape_name": "DNSCnamePrefix", "type": "string", "min_length": 4, "max_length": 63, "documentation": "\n

\n If specified, the environment attempts to use this value as the prefix for the\n CNAME.\n If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.\n\t\t

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application version to deploy.

\n

\n If the specified application has no associated application versions, AWS Elastic Beanstalk\n UpdateEnvironment returns an\n InvalidParameterValue\n error.\n

\n

\n Default: If not specified, AWS Elastic Beanstalk\n attempts to launch the most recently created\n application version.\n

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template to use in\n deployment. If no\n configuration template is found with this\n name, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this parameter or a\n SolutionStackName,\n but not both.\n If you specify both, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error. If you do not specify either, AWS Elastic Beanstalk\n returns a\n MissingRequiredParameter\n error.\n

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n This is an alternative to specifying a configuration name.\n If specified, AWS Elastic Beanstalk\n sets the configuration values to the default values\n associated with the specified solution stack.\n

\n

\n Condition: You must specify either this or a\n TemplateName,\n but not both.\n If you specify both, AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error. If you do not specify either, AWS Elastic Beanstalk\n returns a\n MissingRequiredParameter\n error.\n

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n sets the specified configuration options to the requested value in\n the configuration set for the new environment. These override the values\n obtained from\n the solution stack or the configuration template.\n

\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option.\n\t\t

\n " }, "documentation": "\n

\n A list of custom user-defined configuration options to remove from the\n configuration set for this new environment.\n\t\t

\n " } }, "documentation": "\n\n

\n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of this environment.

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of this environment.\n

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this environment.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The application version deployed in this environment.

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the\n SolutionStack\n deployed with this environment.\n

\n\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template used to\n originally launch this\n environment.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this environment.

\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\n

The URL to the LoadBalancer for this environment.

\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

\n The URL to the CNAME for this environment.\n

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date for this environment.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date for this environment.

\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n

\n The current operational status of the environment:\n\t\t

\n\n \n\n " }, "Health": { "shape_name": "EnvironmentHealth", "type": "string", "enum": [ "Green", "Yellow", "Red", "Grey" ], "documentation": "\n

\n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n

\n \n \n

\n Red\n : Indicates the environment is not working.\n

\n \n \n

\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n

\n \n \n

\n Green: Indicates the environment is\n healthy and fully functional.\n

\n \n \n\n \n

\n Default: Grey\n

\n\n " }, "Resources": { "shape_name": "EnvironmentResourcesDescription", "type": "structure", "members": { "LoadBalancer": { "shape_name": "LoadBalancerDescription", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the LoadBalancer.

\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\n

The domain name of the LoadBalancer.

\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n

The protocol that is used by the Listener.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port that is used by the Listener.

\n " } }, "documentation": "\n

Describes the properties of a Listener for the LoadBalancer.

\n " }, "documentation": "\n

A list of Listeners used by the LoadBalancer.

\n " } }, "documentation": "\n

Describes the LoadBalancer.

\n " } }, "documentation": "\n

The description of the AWS resources used by this environment.

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null } }, "documentation": "\n

Describes the properties of an environment.

\n\n\n " }, "errors": [ { "shape_name": "TooManyEnvironmentsException", "type": "structure", "members": {}, "documentation": "\n

The caller has exceeded the limit of allowed environments associated with the account.

\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Launches an environment for the specified application using\n the specified configuration.\n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&EnvironmentName=SampleApp\n&SolutionStackName=32bit%20Amazon%20Linux%20running%20Tomcat%207\n&Description=EnvDescrip\n&Operation=CreateEnvironment\n&AuthParams \n\n \n \n Version1\n Deploying\n SampleApp\n Grey\n e-icsgecu3wf\n 2010-11-17T03:59:33.520Z\n 32bit Amazon Linux running Tomcat 7\n EnvDescrip\n SampleApp\n 2010-11-17T03:59:33.520Z\n \n \n 15db925e-f1ff-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "CreateStorageLocation": { "name": "CreateStorageLocation", "input": null, "output": { "shape_name": "CreateStorageLocationResultMessage", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\n

\n The name of the Amazon S3 bucket created.\n\t\t

\n " } }, "documentation": "\n

Results of a CreateStorageLocationResult call.

\n " }, "errors": [ { "shape_name": "TooManyBucketsException", "type": "structure", "members": {}, "documentation": "\n

The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.

\n " }, { "shape_name": "S3SubscriptionRequiredException", "type": "structure", "members": {}, "documentation": "\n

The caller does not have a subscription to Amazon S3.

\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Creates the Amazon S3 storage location for the account.\n\t\t

\n

\n This location is used to store user log files.\n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?Operation=CreateStorageLocation\n&AuthParams \n\n \n \n elasticbeanstalk-us-east-1-780612358023\n \n \n ef51b94a-f1d6-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "DeleteApplication": { "name": "DeleteApplication", "input": { "shape_name": "DeleteApplicationMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application to delete.

\n ", "required": true }, "TerminateEnvByForce": { "shape_name": "TerminateEnvForce", "type": "boolean", "documentation": "\n

When set to true, running environments will be terminated before deleting the application.

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": null, "errors": [ { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

\n " } ], "documentation": "\n

\n Deletes the specified application along with all\n associated versions and\n configurations. The application versions will not be deleted from your Amazon S3 bucket.\n

\n You cannot delete an application that has a running environment.\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&Operation=DeleteApplication\n&AuthParams \n\n \n \n 1f155abd-f1d7-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DeleteApplicationVersion": { "name": "DeleteApplicationVersion", "input": { "shape_name": "DeleteApplicationVersionMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application to delete releases from.

\n ", "required": true }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The label of the version to delete.\n

\n ", "required": true }, "DeleteSourceBundle": { "shape_name": "DeleteSourceBundle", "type": "boolean", "documentation": "\n

Indicates whether to delete the associated source bundle from Amazon S3:\n

\n \n

\n Valid Values: true | false\n

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": null, "errors": [ { "shape_name": "SourceBundleDeletionException", "type": "structure", "members": {}, "documentation": "\n

Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.

\n " }, { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " }, { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

\n " }, { "shape_name": "S3LocationNotInServiceRegionException", "type": "structure", "members": {}, "documentation": "\n

The specified S3 bucket does not belong to the S3 region in which the service is running.

\n " } ], "documentation": "\n

\n Deletes the specified version from the specified\n application.\n

\n You cannot delete an application version that is associated with a\n running environment.\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&VersionLabel=First%20Release\n&Operation=DeleteApplicationVersion\n&AuthParams \n\n \n \n 58dc7339-f272-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DeleteConfigurationTemplate": { "name": "DeleteConfigurationTemplate", "input": { "shape_name": "DeleteConfigurationTemplateMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application to delete the configuration\n template from.\n

\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the configuration template to delete.

\n ", "required": true } }, "documentation": "\n\n

This documentation target is not reported in the API reference.

\n " }, "output": null, "errors": [ { "shape_name": "OperationInProgressException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because another operation is already in progress affecting an an element in this activity.

\n " } ], "documentation": "\n

Deletes the specified configuration template.

\n When you launch an environment using a configuration template, the\n environment\n gets a copy of the template. You can delete or modify the environment's copy of\n the template without\n affecting the running environment.\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&TemplateName=SampleAppTemplate\n&Operation=DeleteConfigurationTemplate\n&AuthParams \n\n \n \n af9cf1b6-f25e-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "DeleteEnvironmentConfiguration": { "name": "DeleteEnvironmentConfiguration", "input": { "shape_name": "DeleteEnvironmentConfigurationMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application the environment is associated with.\n\t\t

\n ", "required": true }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to delete the draft configuration from.\n\t\t

\n ", "required": true } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": null, "errors": [], "documentation": "\n

\n Deletes the draft configuration associated with the running environment.\n\t\t

\n

\n Updating a running environment with any configuration changes creates a\n draft configuration set. You can get the draft configuration using\n DescribeConfigurationSettings while the update is in progress \n or if the update fails. The DeploymentStatus for the draft \n configuration indicates whether the deployment is in process or has failed.\n The draft configuration remains in existence until it is deleted with this action.\n

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&EnvironmentName=SampleApp\n&Operation=DeleteEnvironmentConfiguration\n&AuthParams \n\n \n \n fdf76507-f26d-11df-8a78-9f77047e0d0c\n \n\n \n\n " }, "DescribeApplicationVersions": { "name": "DescribeApplicationVersions", "input": { "shape_name": "DescribeApplicationVersionsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n only include ones that are\n associated with the specified application.\n

\n " }, "VersionLabels": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n If specified, restricts the returned descriptions to only include ones\n that have the specified version labels.\n\t

\n " } }, "documentation": "\n\n

Result message containing a list of configuration descriptions.

\n " }, "output": { "shape_name": "ApplicationVersionDescriptionsMessage", "type": "structure", "members": { "ApplicationVersions": { "shape_name": "ApplicationVersionDescriptionList", "type": "list", "members": { "shape_name": "ApplicationVersionDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this release.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

The description of this application version.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n A label uniquely identifying the version for the associated\n application.\n

\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\n

The Amazon S3 bucket where the data is located.

\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\n

The Amazon S3 key where the data is located.

\n " } }, "documentation": "\n

\n The location where the source bundle is located for this version.\n\t

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date of the application version.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date of the application version.

\n " } }, "documentation": "\n

\n Describes the properties of an application version.\n

\n\n\n " }, "documentation": "\n

\n A list of\n ApplicationVersionDescription\n .\n

\n " } }, "documentation": "\n

Result message wrapping a list of application version descriptions.

\n " }, "errors": [], "documentation": "\n

Returns descriptions for existing application versions.

\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&Operation=DescribeApplicationVersions\n&AuthParams \n\n \n \n \n \n \n amazonaws.com\n sample.war\n \n Version1\n description\n SampleApp\n 2010-11-17T03:21:59.161Z\n 2010-11-17T03:21:59.161Z\n \n \n \n \n 773cd80a-f26c-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DescribeApplications": { "name": "DescribeApplications", "input": { "shape_name": "DescribeApplicationsMessage", "type": "structure", "members": { "ApplicationNames": { "shape_name": "ApplicationNamesList", "type": "list", "members": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n only include those with the\n specified names.\n

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "ApplicationDescriptionsMessage", "type": "structure", "members": { "Applications": { "shape_name": "ApplicationDescriptionList", "type": "list", "members": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

User-defined description of the application.

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The date when the application was created.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The date when the application was last modified.

\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

The names of the versions for this application.

\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n The names of the configuration templates associated with this\n application.\n\t

\n " } }, "documentation": "\n

Describes the properties of an application.

\n\n " }, "documentation": "\n

\n This parameter contains a list of\n ApplicationDescription.\n

\n " } }, "documentation": "\n

Result message containing a list of application descriptions.

\n " }, "errors": [], "documentation": "\n

Returns the descriptions of existing applications.

\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationNames.member.1=SampleApplication\n&Operation=DescribeApplications\n&AuthParams \n\n \n \n \n \n \n Sample Description\n SampleApplication\n 2010-11-16T20:20:51.974Z\n 2010-11-16T20:20:51.974Z\n \n Default\n \n \n \n \n \n 577c70ff-f1d7-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DescribeConfigurationOptions": { "name": "DescribeConfigurationOptions", "input": { "shape_name": "DescribeConfigurationOptionsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application associated with the configuration template or\n environment. Only needed if you want to describe the\n configuration options associated with either the configuration template or\n environment.\n\t\t

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template whose configuration options\n you want to describe.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment whose configuration options you want to describe.\n

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack whose configuration options\n you want to describe.\n\t\t

\n " }, "Options": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option.\n\t\t

\n " }, "documentation": "\n

\n If specified, restricts the descriptions to only the specified options.\n\t\t

\n " } }, "documentation": "\n

Result message containig a list of application version descriptions.\n

\n " }, "output": { "shape_name": "ConfigurationOptionsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack these configuration options belong to.\n\t\t

\n " }, "Options": { "shape_name": "ConfigurationOptionDescriptionsList", "type": "list", "members": { "shape_name": "ConfigurationOptionDescription", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "Name": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option.\n\t\t

\n " }, "DefaultValue": { "shape_name": "ConfigurationOptionDefaultValue", "type": "string", "documentation": "\n

\n The default value for this configuration option.\n\t\t

\n " }, "ChangeSeverity": { "shape_name": "ConfigurationOptionSeverity", "type": "string", "documentation": "\n

\n An indication of which action is required if the value for this\n configuration option changes:\n\t\t

\n \n \n

\n NoInterruption - There is no interruption to the\n environment or application availability.\n\t\t\t\t

\n \n \n

\n RestartEnvironment - The environment is\n restarted, all AWS resources are deleted and recreated, and\n the environment is unavailable during the process.\n\t\t\t\t

\n \n \n

\n RestartApplicationServer - The environment is available\n the entire time. However, a short application\n outage occurs when the application servers on the running Amazon EC2 instances\n are restarted.\n\t\t\t\t

\n \n \n \n " }, "UserDefined": { "shape_name": "UserDefinedOption", "type": "boolean", "documentation": "\n

\n An indication of whether the user defined this configuration option:\n\t\t

\n \n \n

\n true\n : This configuration option was defined by the user. It is a\n valid choice for specifying this as an Option to Remove when\n updating configuration settings.\n\n

\n\n \n \n

\n false\n : This configuration was not defined by the user.\n

\n \n \n\n \n

\n Constraint: You can remove only UserDefined\n options from a configuration.\n

\n

\n Valid Values: true | false

\n " }, "ValueType": { "shape_name": "ConfigurationOptionValueType", "type": "string", "enum": [ "Scalar", "List" ], "documentation": "\n

\n An indication of which type of values this option has and whether\n it is allowable to select one or more than one of the possible values:\n\t\t

\n \n \n

\n Scalar\n : Values for this option are a single selection from the\n possible values, or a unformatted string or numeric value governed\n by the MIN/MAX/Regex constraints:\n

\n \n \n

\n List\n : Values for this option are multiple selections of the\n possible values.\n

\n \n \n

\n Boolean\n : Values for this option are either\n true\n or\n false\n .\n

\n \n \n\n

\n

\n

\n\n\n " }, "ValueOptions": { "shape_name": "ConfigurationOptionPossibleValues", "type": "list", "members": { "shape_name": "ConfigurationOptionPossibleValue", "type": "string", "documentation": null }, "documentation": "\n

\n If specified, values for the configuration option are selected\n from this list.\n\t\t

\n " }, "MinValue": { "shape_name": "OptionRestrictionMinValue", "type": "integer", "documentation": "\n

\n If specified, the configuration option must be a numeric value\n greater than this value.\n\t\t

\n " }, "MaxValue": { "shape_name": "OptionRestrictionMaxValue", "type": "integer", "documentation": "\n

\n If specified, the configuration option must be a numeric value less than this\n value.\n\t\t

\n " }, "MaxLength": { "shape_name": "OptionRestrictionMaxLength", "type": "integer", "documentation": "\n

\n If specified, the configuration option must be a string value no longer than\n this value.\n\t\t

\n " }, "Regex": { "shape_name": "OptionRestrictionRegex", "type": "structure", "members": { "Pattern": { "shape_name": "RegexPattern", "type": "string", "documentation": "\n

\n The regular expression pattern that a string configuration option value with\n this restriction must match.\n\t\t

\n " }, "Label": { "shape_name": "RegexLabel", "type": "string", "documentation": "\n

\n A unique name representing this regular expression.\n\t\t

\n " } }, "documentation": "\n

\n If specified, the configuration option must be a string value that satisfies\n this regular expression.\n\t\t

\n " } }, "documentation": "\n

\n Describes the possible values for a configuration option.\n\t\t

\n " }, "documentation": "\n

\n A list of\n ConfigurationOptionDescription.\n

\n " } }, "documentation": "\n

Describes the settings for a specified configuration set.

\n " }, "errors": [], "documentation": "\n

\n Describes the configuration options that are used in a\n particular configuration template or environment, or that \n a specified solution stack defines. The description includes the values the\n options, their default values, and an indication of\n the required action on a running environment if an option value is changed.\n\t\t

\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&TemplateName=default\n&Operation=DescribeConfigurationOptions\n&AuthParams \n\n \n \n 32bit Amazon Linux running Tomcat 7\n \n \n false\n RestartEnvironment\n 2000\n ImageId\n Scalar\n ami-6036c009\n aws:autoscaling:launchconfiguration\n \n \n false\n NoInterruption\n 2000\n Notification Endpoint\n Scalar\n \n aws:elasticbeanstalk:sns:topics\n \n \n false\n RestartApplicationServer\n 2000\n PARAM4\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n RestartApplicationServer\n 2000\n JDBC_CONNECTION_STRING\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n RestartEnvironment\n 2000\n SecurityGroups\n Scalar\n elasticbeanstalk-default\n aws:autoscaling:launchconfiguration\n \n \n false\n NoInterruption\n 2\n UnhealthyThreshold\n Scalar\n 5\n 10\n aws:elb:healthcheck\n \n \n false\n RestartEnvironment\n InstanceType\n \n t1.micro\n m1.small\n \n Scalar\n t1.micro\n aws:autoscaling:launchconfiguration\n \n \n false\n NoInterruption\n Statistic\n \n Minimum\n Maximum\n Sum\n Average\n \n Scalar\n Average\n aws:autoscaling:trigger\n \n \n false\n RestartEnvironment\n LoadBalancerHTTPSPort\n \n OFF\n 443\n 8443\n 5443\n \n Scalar\n OFF\n aws:elb:loadbalancer\n \n \n false\n NoInterruption\n 0\n Stickiness Cookie Expiration\n Scalar\n 0\n 1000000\n aws:elb:policies\n \n \n false\n RestartApplicationServer\n 2000\n PARAM5\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n NoInterruption\n MeasureName\n \n CPUUtilization\n NetworkIn\n NetworkOut\n DiskWriteOps\n DiskReadBytes\n DiskReadOps\n DiskWriteBytes\n Latency\n RequestCount\n HealthyHostCount\n UnhealthyHostCount\n \n Scalar\n NetworkOut\n aws:autoscaling:trigger\n \n \n false\n NoInterruption\n 5\n Interval\n Scalar\n 30\n 300\n aws:elb:healthcheck\n \n \n false\n NoInterruption\n 2000\n Application Healthcheck URL\n Scalar\n /\n aws:elasticbeanstalk:application\n \n \n false\n NoInterruption\n 2000\n Notification Topic ARN\n Scalar\n \n aws:elasticbeanstalk:sns:topics\n \n \n false\n NoInterruption\n 2000\n LowerBreachScaleIncrement\n Scalar\n -1\n aws:autoscaling:trigger\n \n \n false\n RestartApplicationServer\n 2000\n \n ^\\S*$\n \n \n XX:MaxPermSize\n Scalar\n 64m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n false\n NoInterruption\n 2000\n UpperBreachScaleIncrement\n Scalar\n 1\n aws:autoscaling:trigger\n \n \n false\n NoInterruption\n 1\n MinSize\n Scalar\n 1\n 10000\n aws:autoscaling:asg\n \n \n false\n RestartEnvironment\n Custom Availability Zones\n \n us-east-1a\n us-east-1b\n us-east-1c\n us-east-1d\n \n List\n us-east-1a\n aws:autoscaling:asg\n \n \n false\n RestartEnvironment\n Availability Zones\n \n Any 1\n Any 2\n \n Scalar\n Any 1\n aws:autoscaling:asg\n \n \n false\n NoInterruption\n LogPublicationControl\n Boolean\n false\n aws:elasticbeanstalk:hostmanager\n \n \n false\n RestartApplicationServer\n 2000\n JVM Options\n Scalar\n \n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n false\n NoInterruption\n 2000\n Notification Topic Name\n Scalar\n \n aws:elasticbeanstalk:sns:topics\n \n \n false\n RestartApplicationServer\n 2000\n PARAM2\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n RestartEnvironment\n LoadBalancerHTTPPort\n \n OFF\n 80\n 8080\n \n Scalar\n 80\n aws:elb:loadbalancer\n \n \n false\n NoInterruption\n 2\n Timeout\n Scalar\n 5\n 60\n aws:elb:healthcheck\n \n \n false\n NoInterruption\n 1\n BreachDuration\n Scalar\n 2\n 600\n aws:autoscaling:trigger\n \n \n false\n RestartEnvironment\n MonitoringInterval\n \n 1 minute\n 5 minute\n \n Scalar\n 5 minute\n aws:autoscaling:launchconfiguration\n \n \n false\n RestartApplicationServer\n 2000\n PARAM1\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n NoInterruption\n 1\n MaxSize\n Scalar\n 4\n 10000\n aws:autoscaling:asg\n \n \n false\n NoInterruption\n 0\n LowerThreshold\n Scalar\n 2000000\n 20000000\n aws:autoscaling:trigger\n \n \n false\n RestartApplicationServer\n 2000\n AWS_SECRET_KEY\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n RestartApplicationServer\n 2000\n AWS_ACCESS_KEY_ID\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n NoInterruption\n 0\n UpperThreshold\n Scalar\n 6000000\n 20000000\n aws:autoscaling:trigger\n \n \n false\n NoInterruption\n Notification Protocol\n \n http\n https\n email\n email-json\n sqs\n \n Scalar\n email\n aws:elasticbeanstalk:sns:topics\n \n \n false\n NoInterruption\n Unit\n \n Seconds\n Percent\n Bytes\n Bits\n Count\n Bytes/Second\n Bits/Second\n Count/Second\n None\n \n Scalar\n Bytes\n aws:autoscaling:trigger\n \n \n false\n RestartApplicationServer\n 2000\n \n ^\\S*$\n \n \n Xmx\n Scalar\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n false\n NoInterruption\n 0\n Cooldown\n Scalar\n 360\n 10000\n aws:autoscaling:asg\n \n \n false\n NoInterruption\n 1\n Period\n Scalar\n 1\n 600\n aws:autoscaling:trigger\n \n \n false\n RestartApplicationServer\n 2000\n \n ^\\S*$\n \n \n Xms\n Scalar\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n false\n RestartEnvironment\n 2000\n EC2KeyName\n Scalar\n \n aws:autoscaling:launchconfiguration\n \n \n false\n NoInterruption\n Stickiness Policy\n Boolean\n false\n aws:elb:policies\n \n \n false\n RestartApplicationServer\n 2000\n PARAM3\n Scalar\n \n aws:elasticbeanstalk:application:environment\n \n \n false\n NoInterruption\n 2\n HealthyThreshold\n Scalar\n 3\n 10\n aws:elb:healthcheck\n \n \n false\n RestartEnvironment\n 2000\n SSLCertificateId\n Scalar\n \n aws:elb:loadbalancer\n \n \n \n \n e8768900-f272-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DescribeConfigurationSettings": { "name": "DescribeConfigurationSettings", "input": { "shape_name": "DescribeConfigurationSettingsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The application for the environment or configuration template.\n\t\t

\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template to describe. \n

\n

\n Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. \n If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to describe.\n

\n

\n Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " } }, "documentation": "\n

Result message containing all of the configuration settings for a\n specified solution stack or configuration template.

\n " }, "output": { "shape_name": "ConfigurationSettingsDescriptions", "type": "structure", "members": { "ConfigurationSettings": { "shape_name": "ConfigurationSettingsDescriptionList", "type": "list", "members": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack this configuration set uses.\n\t\t

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application associated with this configuration set.\n\t\t

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If not\n null, the name of the configuration template for this configuration set.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

\n Describes this configuration set.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n If not\n null, the name of the environment for this configuration set.\n

\n " }, "DeploymentStatus": { "shape_name": "ConfigurationDeploymentStatus", "type": "string", "enum": [ "deployed", "pending", "failed" ], "documentation": "\n

\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t

\n \n \n

\n null: This configuration is not associated with a running\n environment.\n

\n \n \n

\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n

\n \n \n

\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n

\n \n \n

\n failed: This is a draft configuration, that\n failed to successfully deploy.\n

\n \n \n\n \n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was created.\n\t\t

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was last modified.\n\t\t

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n A list of the configuration options and their values in this configuration\n set.\n\t\t

\n " } }, "documentation": "\n

\n Describes the settings for a configuration set.\n\t\t

\n\n " }, "documentation": "\n

\n A list of\n ConfigurationSettingsDescription.\n

\n " } }, "documentation": "\n

The results from a request to change the configuration settings of an\n environment.

\n " }, "errors": [], "documentation": "\n

\n Returns a description of the settings for the specified\n configuration set, that is, either a configuration template or the\n configuration set associated with a running environment.\n\t\t

\n

\n When describing the settings for the configuration set associated with a\n running environment, it is possible to receive two sets of setting descriptions.\n One is the deployed configuration set, and the other is a draft configuration\n of an environment that is either in the process of deployment or that failed to\n deploy. \n\t\t

\n

Related Topics

\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&TemplateName=default\n&Operation=DescribeConfigurationSettings\n&AuthParams \n\n \n \n \n \n 32bit Amazon Linux running Tomcat 7\n \n \n 32bit Amazon Linux running Tomcat 7\n \n \n ImageId\n ami-f2f0069b\n aws:autoscaling:launchconfiguration\n \n \n Notification Endpoint\n \n aws:elasticbeanstalk:sns:topics\n \n \n PARAM4\n \n aws:elasticbeanstalk:application:environment\n \n \n JDBC_CONNECTION_STRING\n \n aws:elasticbeanstalk:application:environment\n \n \n SecurityGroups\n elasticbeanstalk-default\n aws:autoscaling:launchconfiguration\n \n \n UnhealthyThreshold\n 5\n aws:elb:healthcheck\n \n \n InstanceType\n t1.micro\n aws:autoscaling:launchconfiguration\n \n \n Statistic\n Average\n aws:autoscaling:trigger\n \n \n LoadBalancerHTTPSPort\n OFF\n aws:elb:loadbalancer\n \n \n Stickiness Cookie Expiration\n 0\n aws:elb:policies\n \n \n PARAM5\n \n aws:elasticbeanstalk:application:environment\n \n \n MeasureName\n NetworkOut\n aws:autoscaling:trigger\n \n \n Interval\n 30\n aws:elb:healthcheck\n \n \n Application Healthcheck URL\n /\n aws:elasticbeanstalk:application\n \n \n Notification Topic ARN\n \n aws:elasticbeanstalk:sns:topics\n \n \n LowerBreachScaleIncrement\n -1\n aws:autoscaling:trigger\n \n \n XX:MaxPermSize\n 64m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n UpperBreachScaleIncrement\n 1\n aws:autoscaling:trigger\n \n \n MinSize\n 1\n aws:autoscaling:asg\n \n \n Custom Availability Zones\n us-east-1a\n aws:autoscaling:asg\n \n \n Availability Zones\n Any 1\n aws:autoscaling:asg\n \n \n LogPublicationControl\n false\n aws:elasticbeanstalk:hostmanager\n \n \n JVM Options\n \n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n Notification Topic Name\n \n aws:elasticbeanstalk:sns:topics\n \n \n PARAM2\n \n aws:elasticbeanstalk:application:environment\n \n \n LoadBalancerHTTPPort\n 80\n aws:elb:loadbalancer\n \n \n Timeout\n 5\n aws:elb:healthcheck\n \n \n BreachDuration\n 2\n aws:autoscaling:trigger\n \n \n MonitoringInterval\n 5 minute\n aws:autoscaling:launchconfiguration\n \n \n PARAM1\n \n aws:elasticbeanstalk:application:environment\n \n \n MaxSize\n 4\n aws:autoscaling:asg\n \n \n LowerThreshold\n 2000000\n aws:autoscaling:trigger\n \n \n AWS_SECRET_KEY\n \n aws:elasticbeanstalk:application:environment\n \n \n AWS_ACCESS_KEY_ID\n \n aws:elasticbeanstalk:application:environment\n \n \n UpperThreshold\n 6000000\n aws:autoscaling:trigger\n \n \n Notification Protocol\n email\n aws:elasticbeanstalk:sns:topics\n \n \n Unit\n Bytes\n aws:autoscaling:trigger\n \n \n Xmx\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n Cooldown\n 360\n aws:autoscaling:asg\n \n \n Period\n 1\n aws:autoscaling:trigger\n \n \n Xms\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n EC2KeyName\n \n aws:autoscaling:launchconfiguration\n \n \n Stickiness Policy\n false\n aws:elb:policies\n \n \n PARAM3\n \n aws:elasticbeanstalk:application:environment\n \n \n HealthyThreshold\n 3\n aws:elb:healthcheck\n \n \n SSLCertificateId\n \n aws:elb:loadbalancer\n \n \n Default Configuration Template\n SampleApp\n 2010-11-17T03:20:17.832Z\n Default\n 2010-11-17T03:20:17.832Z\n \n \n \n \n 4bde8884-f273-11df-8a78-9f77047e0d0c\n \n \n \n " }, "DescribeEnvironmentResources": { "name": "DescribeEnvironmentResources", "input": { "shape_name": "DescribeEnvironmentResourcesMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the environment to retrieve AWS resource usage data.\n

\n

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to retrieve AWS resource usage data.\n

\n

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "EnvironmentResourceDescriptionsMessage", "type": "structure", "members": { "EnvironmentResources": { "shape_name": "EnvironmentResourceDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of the environment.

\n " }, "AutoScalingGroups": { "shape_name": "AutoScalingGroupList", "type": "list", "members": { "shape_name": "AutoScalingGroup", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

\n The name of the\n AutoScalingGroup\n .\n

\n " } }, "documentation": "\n

\n Describes an Auto Scaling launch configuration.\n

\n " }, "documentation": "\n

\n The\n AutoScalingGroups\n used by this environment.\n

\n " }, "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The ID of the Amazon EC2 instance.

\n " } }, "documentation": "\n

The description of an Amazon EC2 instance.

\n " }, "documentation": "\n

The Amazon EC2 instances used by this environment.

\n " }, "LaunchConfigurations": { "shape_name": "LaunchConfigurationList", "type": "list", "members": { "shape_name": "LaunchConfiguration", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The name of the launch configuration.

\n " } }, "documentation": "\n

Describes an Auto Scaling launch configuration.

\n " }, "documentation": "\n

The Auto Scaling launch configurations in use by this environment.

\n " }, "LoadBalancers": { "shape_name": "LoadBalancerList", "type": "list", "members": { "shape_name": "LoadBalancer", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The name of the LoadBalancer.

\n " } }, "documentation": "\n

Describes a LoadBalancer.

\n " }, "documentation": "\n

The LoadBalancers in use by this environment.

\n " }, "Triggers": { "shape_name": "TriggerList", "type": "list", "members": { "shape_name": "Trigger", "type": "structure", "members": { "Name": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The name of the trigger.

\n " } }, "documentation": "\n

Describes a trigger.

\n " }, "documentation": "\n

\n The\n AutoScaling\n triggers in use by this environment.\n

\n " }, "Queues": { "shape_name": "QueueList", "type": "list", "members": { "shape_name": "Queue", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "URL": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "documentation": null } }, "documentation": "\n

\n A list of\n EnvironmentResourceDescription.\n

\n " } }, "documentation": "\n

Result message containing a list of environment resource\n descriptions.\n

\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

Returns AWS resources for this environment.

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&Operation=DescribeEnvironmentResources\n&AuthParams \n\n \n \n \n \n \n elasticbeanstalk-SampleAppVersion\n \n \n \n \n elasticbeanstalk-SampleAppVersion-hbAc8cSZH7\n \n \n \n \n elasticbeanstalk-SampleAppVersion-us-east-1c\n \n \n SampleAppVersion\n \n \n elasticbeanstalk-SampleAppVersion-us-east-1c\n \n \n \n \n \n \n e1cb7b96-f287-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "DescribeEnvironments": { "name": "DescribeEnvironments", "input": { "shape_name": "DescribeEnvironmentsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that are\n associated with this application.\n

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that are\n associated with this application version.\n

\n " }, "EnvironmentIds": { "shape_name": "EnvironmentIdList", "type": "list", "members": { "shape_name": "EnvironmentId", "type": "string", "documentation": null }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that have the\n specified IDs.\n

\n " }, "EnvironmentNames": { "shape_name": "EnvironmentNamesList", "type": "list", "members": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": null }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those that have the\n specified names.\n

\n " }, "IncludeDeleted": { "shape_name": "IncludeDeleted", "type": "boolean", "documentation": "\n

Indicates whether to include deleted environments:\n

\n

\n true: Environments that have been deleted after\n IncludedDeletedBackTo\n are displayed.\n

\n\n

\n false: Do not include deleted environments.\n

\n " }, "IncludedDeletedBackTo": { "shape_name": "IncludeDeletedBackTo", "type": "timestamp", "documentation": "\n

\n If specified when\n IncludeDeleted\n is set to\n true,\n then environments deleted after this date are displayed.\n

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "EnvironmentDescriptionsMessage", "type": "structure", "members": { "Environments": { "shape_name": "EnvironmentDescriptionsList", "type": "list", "members": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of this environment.

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of this environment.\n

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this environment.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The application version deployed in this environment.

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the\n SolutionStack\n deployed with this environment.\n

\n\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template used to\n originally launch this\n environment.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this environment.

\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\n

The URL to the LoadBalancer for this environment.

\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

\n The URL to the CNAME for this environment.\n

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date for this environment.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date for this environment.

\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n

\n The current operational status of the environment:\n\t\t

\n\n \n\n " }, "Health": { "shape_name": "EnvironmentHealth", "type": "string", "enum": [ "Green", "Yellow", "Red", "Grey" ], "documentation": "\n

\n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n

\n \n \n

\n Red\n : Indicates the environment is not working.\n

\n \n \n

\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n

\n \n \n

\n Green: Indicates the environment is\n healthy and fully functional.\n

\n \n \n\n \n

\n Default: Grey\n

\n\n " }, "Resources": { "shape_name": "EnvironmentResourcesDescription", "type": "structure", "members": { "LoadBalancer": { "shape_name": "LoadBalancerDescription", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the LoadBalancer.

\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\n

The domain name of the LoadBalancer.

\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n

The protocol that is used by the Listener.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port that is used by the Listener.

\n " } }, "documentation": "\n

Describes the properties of a Listener for the LoadBalancer.

\n " }, "documentation": "\n

A list of Listeners used by the LoadBalancer.

\n " } }, "documentation": "\n

Describes the LoadBalancer.

\n " } }, "documentation": "\n

The description of the AWS resources used by this environment.

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null } }, "documentation": "\n

Describes the properties of an environment.

\n\n\n " }, "documentation": "\n

\n Returns an EnvironmentDescription list.\n

\n " } }, "documentation": "\n

Result message containing a list of environment descriptions.

\n " }, "errors": [], "documentation": "\n

Returns descriptions for existing environments.

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&IncludeDeleted=true\n&IncludedDeletedBackTo=2008-11-05T06%3A00%3A00Z\n&Operation=DescribeEnvironments\n&AuthParams \n\n \n \n \n \n Version1\n Available\n SampleApp\n elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com\n SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com\n Green\n e-icsgecu3wf\n 2010-11-17T04:01:40.668Z\n 32bit Amazon Linux running Tomcat 7\n EnvDescrip\n SampleApp\n 2010-11-17T03:59:33.520Z\n \n \n \n \n 44790c68-f260-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "DescribeEvents": { "name": "DescribeEvents", "input": { "shape_name": "DescribeEventsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n include only those associated\n with this application.\n

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n application version.\n

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that are associated with\n this environment\n configuration.\n

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n environment.\n

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those associated with this\n environment.\n

\n " }, "RequestId": { "shape_name": "RequestId", "type": "string", "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the described events to include only those\n associated with this request ID.\n

\n " }, "Severity": { "shape_name": "EventSeverity", "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ], "documentation": "\n

\n If specified, limits the events returned from this call to include only those\n with the\n specified severity or higher.\n\t\t

\n " }, "StartTime": { "shape_name": "TimeFilterStart", "type": "timestamp", "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that occur on or after this\n time.\n

\n " }, "EndTime": { "shape_name": "TimeFilterEnd", "type": "timestamp", "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n restricts the returned descriptions to\n those that occur up to, but not including, the\n EndTime.\n

\n " }, "MaxRecords": { "shape_name": "MaxRecords", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n

\n Specifies the maximum number of events that can be returned, beginning with the most recent event.\n\t\t

\n " }, "NextToken": { "shape_name": "Token", "type": "string", "documentation": "\n

\n Pagination token. If specified, the events return the next batch of results.\n\t\t

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "EventDescriptionsMessage", "type": "structure", "members": { "Events": { "shape_name": "EventDescriptionList", "type": "list", "members": { "shape_name": "EventDescription", "type": "structure", "members": { "EventDate": { "shape_name": "EventDate", "type": "timestamp", "documentation": "\n

The date when the event occurred.

\n " }, "Message": { "shape_name": "EventMessage", "type": "string", "documentation": "\n

The event message.

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The application associated with the event.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The release label for the application version associated with this\n event.

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the configuration associated with this event.

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of the environment associated with this event.

\n " }, "RequestId": { "shape_name": "RequestId", "type": "string", "documentation": "\n

The web service request ID for the activity of this event.

\n " }, "Severity": { "shape_name": "EventSeverity", "type": "string", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ], "documentation": "\n

The severity level of this event.

\n " } }, "documentation": "\n

Describes an event.

\n " }, "documentation": "\n

\n A list of\n EventDescription.\n

\n " }, "NextToken": { "shape_name": "Token", "type": "string", "documentation": "\n

\n If returned, this indicates that there are more results to obtain.\n Use this token in the next\n DescribeEvents\n call to\n get the next batch of events.\n

\n " } }, "documentation": "\n

Result message wrapping a list of event descriptions.

\n " }, "errors": [], "documentation": "\n

Returns list of event descriptions matching criteria up to the last 6 weeks.

\n \n This action returns the most recent 1,000 events from the specified\n NextToken.\n \n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&Severity=TRACE\n&StartTime=2010-11-17T10%3A26%3A40Z\n&Operation=DescribeEvents\n&AuthParams \n\n \n \n \n \n Successfully completed createEnvironment activity.\n 2010-11-17T20:25:35.191Z\n New Version\n bb01fa74-f287-11df-8a78-9f77047e0d0c\n SampleApp\n SampleAppVersion\n INFO\n \n \n Launching a new EC2 instance: i-04a8c569\n 2010-11-17T20:21:30Z\n New Version\n SampleApp\n SampleAppVersion\n DEBUG\n \n \n At least one EC2 instance has entered the InService lifecycle state.\n 2010-11-17T20:20:32.008Z\n New Version\n bb01fa74-f287-11df-8a78-9f77047e0d0c\n SampleApp\n SampleAppVersion\n INFO\n \n \n Elastic Load Balancer elasticbeanstalk-SampleAppVersion has failed 0 healthy instances - Environment may not be available.\n 2010-11-17T20:19:28Z\n New Version\n SampleApp\n SampleAppVersion\n WARN\n \n \n \n \n f10d02dd-f288-11df-8a78-9f77047e0d0c\n \n \n \n\n ", "pagination": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Events", "py_input_token": "next_token" } }, "ListAvailableSolutionStacks": { "name": "ListAvailableSolutionStacks", "input": null, "output": { "shape_name": "ListAvailableSolutionStacksResultMessage", "type": "structure", "members": { "SolutionStacks": { "shape_name": "AvailableSolutionStackNamesList", "type": "list", "members": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": null }, "documentation": "\n

\n A list of available solution stacks.\n\t\t

\n " }, "SolutionStackDetails": { "shape_name": "AvailableSolutionStackDetailsList", "type": "list", "members": { "shape_name": "SolutionStackDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack.\n

\n " }, "PermittedFileTypes": { "shape_name": "SolutionStackFileTypeList", "type": "list", "members": { "shape_name": "FileTypeExtension", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n The permitted file types allowed for a solution stack.\n

\n " } }, "documentation": "\n

Describes the solution stack.\n

\n " }, "documentation": "\n

\n A list of available solution stacks and their SolutionStackDescription.\n

\n " } }, "documentation": "\n

A\n list of available AWS Elastic Beanstalk\n solution stacks.\n

\n " }, "errors": [], "documentation": "\n

\n Returns a list of the available solution stack names.\n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?Operation=ListAvailableSolutionStacks\n&AuthParams \n\n \n \n \n 64bit Amazon Linux running Tomcat 6\n 32bit Amazon Linux running Tomcat 6\n 64bit Amazon Linux running Tomcat 7\n 32bit Amazon Linux running Tomcat 7\n \n \n \n f21e2a92-f1fc-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "RebuildEnvironment": { "name": "RebuildEnvironment", "input": { "shape_name": "RebuildEnvironmentMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the environment to rebuild.\n

\n

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to rebuild.\n\t\t

\n\t\t

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load\n balancer, etc.)\n for a specified environment and forces a restart. \n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&Operation=RebuildEnvironment\n&AuthParams \n\n \n \n a7d6606e-f289-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "RequestEnvironmentInfo": { "name": "RequestEnvironmentInfo", "input": { "shape_name": "RequestEnvironmentInfoMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

The ID of the environment of the requested data.

\n

\n If no such environment is found, RequestEnvironmentInfo returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of the environment of the requested data.

\n

\n If no such environment is found, RequestEnvironmentInfo returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "InfoType": { "shape_name": "EnvironmentInfoType", "type": "string", "enum": [ "tail" ], "documentation": "\n

\n The type of information to request. \n

\n ", "required": true } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": null, "errors": [], "documentation": "\n

\n Initiates a request to compile the specified type of\n information of the deployed environment.\n

\n\n

\n Setting the InfoType to tail\n compiles the last lines from the application server log files of every\n Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo\n to access the compiled information.\n

\n

Related Topics

\n \n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&InfoType=tail\n&Operation=RequestEnvironmentInfo\n&AuthParams \n\n \n \n 126a4ff3-f28a-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "RestartAppServer": { "name": "RestartAppServer", "input": { "shape_name": "RestartAppServerMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the environment to restart the server for.\n\t\t

\n\t\t

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to restart the server for.\n\t\t

\n\t\t

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Causes the environment to restart the application\n container server running on each Amazon EC2 instance. \n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&Operation=RestartAppServer\n&AuthParams \n \n \n 90e8d1d5-f28a-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "RetrieveEnvironmentInfo": { "name": "RetrieveEnvironmentInfo", "input": { "shape_name": "RetrieveEnvironmentInfoMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

The ID of the data's environment.

\n

\n If no such environment is found, returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n \n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of the data's environment.

\n

\n If no such environment is found, returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "InfoType": { "shape_name": "EnvironmentInfoType", "type": "string", "enum": [ "tail" ], "documentation": "\n

\n The type of information to retrieve. \n

\n ", "required": true } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "RetrieveEnvironmentInfoResultMessage", "type": "structure", "members": { "EnvironmentInfo": { "shape_name": "EnvironmentInfoDescriptionList", "type": "list", "members": { "shape_name": "EnvironmentInfoDescription", "type": "structure", "members": { "InfoType": { "shape_name": "EnvironmentInfoType", "type": "string", "enum": [ "tail" ], "documentation": "\n

The type of information retrieved.

\n " }, "Ec2InstanceId": { "shape_name": "Ec2InstanceId", "type": "string", "documentation": "\n

The Amazon EC2 Instance ID for this information.

\n " }, "SampleTimestamp": { "shape_name": "SampleTimestamp", "type": "timestamp", "documentation": "\n

The time stamp when this information was retrieved.

\n " }, "Message": { "shape_name": "Message", "type": "string", "documentation": "\n

The retrieved information.

\n " } }, "documentation": "\n

The information retrieved from the Amazon EC2 instances.

\n " }, "documentation": "\n

\n The\n EnvironmentInfoDescription\n of the environment.\n

\n " } }, "documentation": "\n

Result message containing a description of the requested environment\n info.

\n " }, "errors": [], "documentation": "\n

\n Retrieves the compiled information from a\n RequestEnvironmentInfo\n request.\n

\n

Related Topics

\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&InfoType=tail\n&Operation=RetrieveEnvironmentInfo\n&AuthParams \n\n \n \n \n \n \n https://elasticbeanstalk.us-east-1.s3.amazonaws.com/environments%2Fa514386a-709f-4888-9683-068c38d744b4%2Flogs%2Fi-92a3ceff%2F278756a8-7d83-4bc1-93db-b1763163705a.log?Expires=1291236023\n &AuthParams\n \n 2010-11-17T20:40:23.210Z\n tail\n i-92a3ceff\n \n \n \n \n e8e785c9-f28a-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "SwapEnvironmentCNAMEs": { "name": "SwapEnvironmentCNAMEs", "input": { "shape_name": "SwapEnvironmentCNAMEsMessage", "type": "structure", "members": { "SourceEnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the source environment.\n

\n

\n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. \n You may also specify both.\n If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.\n

\n " }, "SourceEnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the source environment.\n

\n

\n Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. \n You may also specify both.\n If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.\n

\n " }, "DestinationEnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of the destination environment.\n

\n

\n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. \n You may also specify both.\n You must specify the SourceEnvironmentId with the DestinationEnvironmentId.\n

\n " }, "DestinationEnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the destination environment.\n

\n

\n Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. \n You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.\n

\n " } }, "documentation": "\n

\n " }, "output": null, "errors": [], "documentation": "\n

\n Swaps the CNAMEs of two environments. \n

\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?SourceEnvironmentName=SampleApp\n&DestinationEnvironmentName=SampleApp2\n&Operation=SwapEnvironmentCNAMEs\n&AuthParams\n \n \n \n f4e1b145-9080-11e0-8e5a-a558e0ce1fc4\n \n \n \n \n " }, "TerminateEnvironment": { "name": "TerminateEnvironment", "input": { "shape_name": "TerminateEnvironmentMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

The ID of the environment to terminate.

\n

\n Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of the environment to terminate.

\n

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n " }, "TerminateResources": { "shape_name": "TerminateEnvironmentResources", "type": "boolean", "documentation": "\n

\n Indicates whether the associated AWS resources should shut down\n when the environment is terminated:\n\t\t

\n \n \n

\n true: (default) The user AWS resources\n (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated\n along with the environment.\n

\n \n \n

\n false:\n The environment is removed from the\n\t\t\t\t\tAWS Elastic Beanstalk\n but the AWS resources continue to operate.\n\n

\n \n \n\n \n

\n For more information, see the\n \n AWS Elastic Beanstalk\n User Guide.\n \n

\n\n

\n Default:\n true\n

\n

\n Valid Values:\n true\n |\n false\n

\n\n " } }, "documentation": "\n\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of this environment.

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of this environment.\n

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this environment.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The application version deployed in this environment.

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the\n SolutionStack\n deployed with this environment.\n

\n\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template used to\n originally launch this\n environment.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this environment.

\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\n

The URL to the LoadBalancer for this environment.

\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

\n The URL to the CNAME for this environment.\n

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date for this environment.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date for this environment.

\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n

\n The current operational status of the environment:\n\t\t

\n\n \n\n " }, "Health": { "shape_name": "EnvironmentHealth", "type": "string", "enum": [ "Green", "Yellow", "Red", "Grey" ], "documentation": "\n

\n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n

\n \n \n

\n Red\n : Indicates the environment is not working.\n

\n \n \n

\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n

\n \n \n

\n Green: Indicates the environment is\n healthy and fully functional.\n

\n \n \n\n \n

\n Default: Grey\n

\n\n " }, "Resources": { "shape_name": "EnvironmentResourcesDescription", "type": "structure", "members": { "LoadBalancer": { "shape_name": "LoadBalancerDescription", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the LoadBalancer.

\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\n

The domain name of the LoadBalancer.

\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n

The protocol that is used by the Listener.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port that is used by the Listener.

\n " } }, "documentation": "\n

Describes the properties of a Listener for the LoadBalancer.

\n " }, "documentation": "\n

A list of Listeners used by the LoadBalancer.

\n " } }, "documentation": "\n

Describes the LoadBalancer.

\n " } }, "documentation": "\n

The description of the AWS resources used by this environment.

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null } }, "documentation": "\n

Describes the properties of an environment.

\n\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Terminates the specified environment.\n\t\t

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-icsgecu3wf\n&EnvironmentName=SampleApp\n&TerminateResources=true\n&Operation=TerminateEnvironment\n&AuthParams \n\n \n \n Version1\n Terminating\n SampleApp\n elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com\n SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com\n Grey\n e-icsgecu3wf\n 2010-11-17T17:10:41.976Z\n 32bit Amazon Linux running Tomcat 7\n EnvDescrip\n SampleApp\n 2010-11-17T03:59:33.520Z\n \n \n 9b71af21-f26d-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "UpdateApplication": { "name": "UpdateApplication", "input": { "shape_name": "UpdateApplicationMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application to update. If no such application\n is found, UpdateApplication returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

\n A new description for the application. \n

\n

Default:\n If not specified, AWS Elastic Beanstalk\n does not update the description.\n

\n " } }, "documentation": "\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "ApplicationDescriptionMessage", "type": "structure", "members": { "Application": { "shape_name": "ApplicationDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

User-defined description of the application.

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The date when the application was created.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The date when the application was last modified.

\n " }, "Versions": { "shape_name": "VersionLabelsList", "type": "list", "members": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

The names of the versions for this application.

\n " }, "ConfigurationTemplates": { "shape_name": "ConfigurationTemplateNamesList", "type": "list", "members": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": null }, "documentation": "\n

\n The names of the configuration templates associated with this\n application.\n\t

\n " } }, "documentation": "\n

\n The\n ApplicationDescription\n of the application.\n

\n " } }, "documentation": "\n

Result message containing a single description of an application.

\n " }, "errors": [], "documentation": "\n

Updates the specified application to have the specified\n properties.\t

\n \n If a property (for example, description) is not provided, the\n value\n remains unchanged. To clear these properties, specify an empty string.\n \n \nhttps://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&Description=Another%20Description\n&Operation=UpdateApplication\n&AuthParams \n\n \n \n \n \n New Version\n \n Another Description\n SampleApp\n 2010-11-17T19:26:20.410Z\n 2010-11-17T20:42:54.611Z\n \n Default\n \n \n \n \n 40be666b-f28b-11df-8a78-9f77047e0d0c\n \n \n \n " }, "UpdateApplicationVersion": { "name": "UpdateApplicationVersion", "input": { "shape_name": "UpdateApplicationVersionMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application associated with this version.\n

\n

\n If no application is found with this name, UpdateApplication returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the version to update.

\n

\n If no application version is found with this label, UpdateApplication returns\n an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

A new description for this release.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ApplicationVersionDescriptionMessage", "type": "structure", "members": { "ApplicationVersion": { "shape_name": "ApplicationVersionDescription", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this release.

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

The description of this application version.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n A label uniquely identifying the version for the associated\n application.\n

\n " }, "SourceBundle": { "shape_name": "S3Location", "type": "structure", "members": { "S3Bucket": { "shape_name": "S3Bucket", "type": "string", "max_length": 255, "documentation": "\n

The Amazon S3 bucket where the data is located.

\n " }, "S3Key": { "shape_name": "S3Key", "type": "string", "max_length": 1024, "documentation": "\n

The Amazon S3 key where the data is located.

\n " } }, "documentation": "\n

\n The location where the source bundle is located for this version.\n\t

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date of the application version.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date of the application version.

\n " } }, "documentation": "\n

\n The\n ApplicationVersionDescription\n of the application version.\n

\n " } }, "documentation": "\n

\n Result message wrapping a single description of an application\n version.\n

\n " }, "errors": [], "documentation": "\n

\n Updates the specified application version to have the specified\n properties.\n \n

\n\n \n If a property (for example,\n description) is not provided, the\n value remains unchanged. To clear properties,\n specify an empty string.\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&VersionLabel=New%20Version\n&Description=New%20Release%20Description\n&Operation=UpdateApplicationVersion\n&AuthParams \n\n \n \n \n \n awsemr\n sample.war\n \n New Version\n New Release Description\n SampleApp\n 2010-11-17T19:26:20.699Z\n 2010-11-17T20:48:16.632Z\n \n \n \n 00b10aa1-f28c-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "UpdateConfigurationTemplate": { "name": "UpdateConfigurationTemplate", "input": { "shape_name": "UpdateConfigurationTemplateMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with the configuration template\n to update.

\n

\n If no application is found with this name, UpdateConfigurationTemplate returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the configuration template to update.

\n

\n If no configuration template is found with this name, UpdateConfigurationTemplate returns an\n InvalidParameterValue\n error.\n

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

A new description for the configuration.

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n A list of configuration option settings to update with the new specified\n option value.\n\t\t

\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option.\n\t\t

\n " }, "documentation": "\n

\n A list of configuration options to remove from the configuration set.\n\t\t

\n

\n Constraint: You can remove only UserDefined\n configuration options.\n

\n " } }, "documentation": "\n\n

The result message containing the options for the specified solution\n stack.

\n " }, "output": { "shape_name": "ConfigurationSettingsDescription", "type": "structure", "members": { "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the solution stack this configuration set uses.\n\t\t

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application associated with this configuration set.\n\t\t

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If not\n null, the name of the configuration template for this configuration set.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

\n Describes this configuration set.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n If not\n null, the name of the environment for this configuration set.\n

\n " }, "DeploymentStatus": { "shape_name": "ConfigurationDeploymentStatus", "type": "string", "enum": [ "deployed", "pending", "failed" ], "documentation": "\n

\n If this configuration set is associated with an environment, the \n DeploymentStatus parameter indicates\n the deployment status of this configuration set:\n\t\t

\n \n \n

\n null: This configuration is not associated with a running\n environment.\n

\n \n \n

\n pending: This is a draft configuration that is not deployed\n to the\n associated environment but is in the process of deploying.\n

\n \n \n

\n deployed: This is the configuration that is currently deployed\n to the associated running environment.\n

\n \n \n

\n failed: This is a draft configuration, that\n failed to successfully deploy.\n

\n \n \n\n \n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was created.\n\t\t

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

\n The date (in UTC time) when this configuration set was last modified.\n\t\t

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n A list of the configuration options and their values in this configuration\n set.\n\t\t

\n " } }, "documentation": "\n

\n Describes the settings for a configuration set.\n\t\t

\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Updates the specified configuration template to have the specified\n properties or configuration option values.\n\t

\n \n If a property (for example,\n ApplicationName) is not provided, its\n value remains unchanged. To clear such\n properties, specify an empty string.\n \n

Related Topics

\n \n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&TemplateName=default\n&Description=changed%20description\n&OptionSettings.member.1.Namespace=aws%3Aautoscaling%3Atrigger\n&OptionSettings.member.1.OptionName=LowerThreshold\n&OptionSettings.member.1.Value=1000000\n&Operation=UpdateConfigurationTemplate\n&AuthParams \n \n \n 32bit Amazon Linux running Tomcat 7\n \n \n Availability Zones\n Any 1\n aws:autoscaling:asg\n \n \n PARAM5\n \n aws:elasticbeanstalk:application:environment\n \n \n LowerThreshold\n 1000000\n aws:autoscaling:trigger\n \n \n UpperThreshold\n 9000000\n aws:autoscaling:trigger\n \n \n LowerBreachScaleIncrement\n -1\n aws:autoscaling:trigger\n \n \n MeasureName\n NetworkOut\n aws:autoscaling:trigger\n \n \n Period\n 60\n aws:autoscaling:trigger\n \n \n Xmx\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n PARAM3\n \n aws:elasticbeanstalk:application:environment\n \n \n EC2KeyName\n \n aws:autoscaling:launchconfiguration\n \n \n MinSize\n 1\n aws:autoscaling:asg\n \n \n JVM Options\n \n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n XX:MaxPermSize\n 64m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n AWS_SECRET_KEY\n \n aws:elasticbeanstalk:application:environment\n \n \n UpperBreachScaleIncrement\n 1\n aws:autoscaling:trigger\n \n \n Notification Topic ARN\n \n aws:elasticbeanstalk:sns:topics\n \n \n InstanceType\n t1.micro\n aws:autoscaling:launchconfiguration\n \n \n Custom Availability Zones\n us-east-1a\n aws:autoscaling:asg\n \n \n Statistic\n Average\n aws:autoscaling:trigger\n \n \n Notification Protocol\n email\n aws:elasticbeanstalk:sns:topics\n \n \n JDBC_CONNECTION_STRING\n \n aws:elasticbeanstalk:application:environment\n \n \n PARAM2\n \n aws:elasticbeanstalk:application:environment\n \n \n Stickiness Cookie Expiration\n 0\n aws:elb:policies\n \n \n SSLCertificateId\n \n aws:elb:loadbalancer\n \n \n MaxSize\n 4\n aws:autoscaling:asg\n \n \n Stickiness Policy\n false\n aws:elb:policies\n \n \n Notification Topic Name\n \n aws:elasticbeanstalk:sns:topics\n \n \n SecurityGroups\n elasticbeanstalk-default\n aws:autoscaling:launchconfiguration\n \n \n LoadBalancerHTTPPort\n 80\n aws:elb:loadbalancer\n \n \n Unit\n None\n aws:autoscaling:trigger\n \n \n AWS_ACCESS_KEY_ID\n \n aws:elasticbeanstalk:application:environment\n \n \n PARAM4\n \n aws:elasticbeanstalk:application:environment\n \n \n Application Healthcheck URL\n /\n aws:elasticbeanstalk:application\n \n \n LoadBalancerHTTPSPort\n OFF\n aws:elb:loadbalancer\n \n \n HealthyThreshold\n 3\n aws:elb:healthcheck\n \n \n Timeout\n 5\n aws:elb:healthcheck\n \n \n Cooldown\n 0\n aws:autoscaling:asg\n \n \n UnhealthyThreshold\n 5\n aws:elb:healthcheck\n \n \n Interval\n 30\n aws:elb:healthcheck\n \n \n LogPublicationControl\n false\n aws:elasticbeanstalk:hostmanager\n \n \n BreachDuration\n 120\n aws:autoscaling:trigger\n \n \n PARAM1\n \n aws:elasticbeanstalk:application:environment\n \n \n Notification Endpoint\n \n aws:elasticbeanstalk:sns:topics\n \n \n Protocol\n HTTP\n aws:elb:loadbalancer\n \n \n Xms\n 256m\n aws:elasticbeanstalk:container:tomcat:jvmoptions\n \n \n changed description\n SampleApp\n 2010-11-17T19:26:20.420Z\n Default\n 2010-11-17T20:58:27.508Z\n \n \n 6cbcb09a-f28d-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "UpdateEnvironment": { "name": "UpdateEnvironment", "input": { "shape_name": "UpdateEnvironmentMessage", "type": "structure", "members": { "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

The ID of the environment to update.

\n

\n If no environment with this ID exists, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentName, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The\n name of the environment to update. If no environment with this name\n exists, \n AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n

\n Condition: You must specify either this or an EnvironmentId, or both. \n If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.\n\t\t

\n\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

\n If this parameter is specified, AWS Elastic Beanstalk\n updates the description\n of this environment.\n

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If this parameter is specified, AWS Elastic Beanstalk\n deploys the named\n application version to the environment. If no such\n application version is\n found, returns an\n InvalidParameterValue\n error.\n

\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n If this parameter is specified, AWS Elastic Beanstalk\n deploys this\n configuration template to the environment. If no such\n configuration\n template is found, AWS Elastic Beanstalk\n returns an\n InvalidParameterValue\n error.\n

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n If specified, AWS Elastic Beanstalk\n updates the configuration set associated with\n the running environment and sets the specified configuration options to\n the requested value.\n

\n " }, "OptionsToRemove": { "shape_name": "OptionsSpecifierList", "type": "list", "members": { "shape_name": "OptionSpecification", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option.\n\t\t

\n " }, "documentation": "\n

\n A list of custom user-defined configuration options to remove from the\n configuration set for this environment.\n\t\t

\n " } }, "documentation": "\n\n

This documentation target is not reported in the API reference.

\n " }, "output": { "shape_name": "EnvironmentDescription", "type": "structure", "members": { "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

The name of this environment.

\n " }, "EnvironmentId": { "shape_name": "EnvironmentId", "type": "string", "documentation": "\n

\n The ID of this environment.\n

\n " }, "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The name of the application associated with this environment.

\n " }, "VersionLabel": { "shape_name": "VersionLabel", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

The application version deployed in this environment.

\n " }, "SolutionStackName": { "shape_name": "SolutionStackName", "type": "string", "max_length": 100, "documentation": "\n

\n The name of the\n SolutionStack\n deployed with this environment.\n

\n\n " }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template used to\n originally launch this\n environment.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "max_length": 200, "documentation": "\n

Describes this environment.

\n " }, "EndpointURL": { "shape_name": "EndpointURL", "type": "string", "documentation": "\n

The URL to the LoadBalancer for this environment.

\n " }, "CNAME": { "shape_name": "DNSCname", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

\n The URL to the CNAME for this environment.\n

\n " }, "DateCreated": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n

The creation date for this environment.

\n " }, "DateUpdated": { "shape_name": "UpdateDate", "type": "timestamp", "documentation": "\n

The last modified date for this environment.

\n " }, "Status": { "shape_name": "EnvironmentStatus", "type": "string", "enum": [ "Launching", "Updating", "Ready", "Terminating", "Terminated" ], "documentation": "\n

\n The current operational status of the environment:\n\t\t

\n\n \n\n " }, "Health": { "shape_name": "EnvironmentHealth", "type": "string", "enum": [ "Green", "Yellow", "Red", "Grey" ], "documentation": "\n

\n Describes the health status of the environment. \n\t\t\tAWS Elastic Beanstalk\n indicates the failure levels for a running environment:\n

\n \n \n

\n Red\n : Indicates the environment is not working.\n

\n \n \n

\n Yellow: Indicates that something is wrong, the application\n might not be available, but the instances appear running.\n

\n \n \n

\n Green: Indicates the environment is\n healthy and fully functional.\n

\n \n \n\n \n

\n Default: Grey\n

\n\n " }, "Resources": { "shape_name": "EnvironmentResourcesDescription", "type": "structure", "members": { "LoadBalancer": { "shape_name": "LoadBalancerDescription", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the LoadBalancer.

\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\n

The domain name of the LoadBalancer.

\n " }, "Listeners": { "shape_name": "LoadBalancerListenersDescription", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n

The protocol that is used by the Listener.

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The port that is used by the Listener.

\n " } }, "documentation": "\n

Describes the properties of a Listener for the LoadBalancer.

\n " }, "documentation": "\n

A list of Listeners used by the LoadBalancer.

\n " } }, "documentation": "\n

Describes the LoadBalancer.

\n " } }, "documentation": "\n

The description of the AWS resources used by this environment.

\n " }, "Tier": { "shape_name": "EnvironmentTier", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": null }, "Type": { "shape_name": "String", "type": "string", "documentation": null }, "Version": { "shape_name": "String", "type": "string", "documentation": null } }, "documentation": null } }, "documentation": "\n

Describes the properties of an environment.

\n\n\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Updates the environment description, deploys a new application\n version, updates the configuration settings to an entirely new configuration\n template, or updates select configuration option values in the running\n environment.\n\t\t

\n

\n Attempting to update both the release and configuration is\n not allowed and AWS Elastic Beanstalk\n returns an\n InvalidParameterCombination\n error.\n

\n

\n When updating the configuration settings to a new template or\n individual settings,\n a draft configuration is created and\n DescribeConfigurationSettings\n for this\n environment returns two setting descriptions with different\n DeploymentStatus\n values.\n

\n\n \n https://elasticbeanstalk.us-east-1.amazon.com/?EnvironmentId=e-hc8mvnayrx\n&EnvironmentName=SampleAppVersion\n&TemplateName=default\n&OptionsToRemove.member.1.Namespace=aws%3Aautoscaling%3Atrigger\n&OptionsToRemove.member.1.OptionName=MeasureName\n&Operation=UpdateEnvironment\n&AuthParams \n\n \n \n New Version\n Deploying\n SampleApp\n elasticbeanstalk-SampleAppVersion-246126201.us-east-1.elb.amazonaws.com\n SampleApp.elasticbeanstalk.amazonaws.com\n Grey\n e-hc8mvnayrx\n 2010-11-17T21:05:55.251Z\n 32bit Amazon Linux running Tomcat 7\n SampleAppDescription\n SampleAppVersion\n 2010-11-17T20:17:42.339Z\n \n \n 7705f0bc-f28e-11df-8a78-9f77047e0d0c\n \n \n \n\n " }, "ValidateConfigurationSettings": { "name": "ValidateConfigurationSettings", "input": { "shape_name": "ValidateConfigurationSettingsMessage", "type": "structure", "members": { "ApplicationName": { "shape_name": "ApplicationName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the application that the configuration template or environment\n belongs to.\n\t\t

\n ", "required": true }, "TemplateName": { "shape_name": "ConfigurationTemplateName", "type": "string", "min_length": 1, "max_length": 100, "documentation": "\n

\n The name of the configuration template to validate the settings against.\n\t\t

\n

\n Condition: You cannot specify both this and an environment name.\n\t\t

\n " }, "EnvironmentName": { "shape_name": "EnvironmentName", "type": "string", "min_length": 4, "max_length": 23, "documentation": "\n

\n The name of the environment to validate the settings against.\n\t\t

\n

\n Condition: You cannot specify both this and a configuration template name.\n\t\t

\n " }, "OptionSettings": { "shape_name": "ConfigurationOptionSettingsList", "type": "list", "members": { "shape_name": "ConfigurationOptionSetting", "type": "structure", "members": { "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n A unique namespace identifying the option's associated AWS resource.\n\t\t

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n The name of the configuration option. \n\t\t

\n " }, "Value": { "shape_name": "ConfigurationOptionValue", "type": "string", "documentation": "\n

\n The current value for the configuration option.\n\t\t

\n " } }, "documentation": "\n

\n A specification identifying an individual configuration option along with its\n current value. For a list of possible option values, go to Option Values in the \nAWS Elastic Beanstalk Developer Guide.\n\t\t

\n\n " }, "documentation": "\n

\n A list of the options and desired values to evaluate.\n\t\t

\n ", "required": true } }, "documentation": "\n

A list of validation messages for a specified configuration template.\n

\n " }, "output": { "shape_name": "ConfigurationSettingsValidationMessages", "type": "structure", "members": { "Messages": { "shape_name": "ValidationMessagesList", "type": "list", "members": { "shape_name": "ValidationMessage", "type": "structure", "members": { "Message": { "shape_name": "ValidationMessageString", "type": "string", "documentation": "\n

\n A message describing the error or warning.\n\t\t

\n " }, "Severity": { "shape_name": "ValidationSeverity", "type": "string", "enum": [ "error", "warning" ], "documentation": "\n

\n An indication of the severity of this message:\n\t\t

\n \n \n

\n error: This message indicates that this is not a valid setting for an option.\n

\n \n \n

\n warning: This message is providing information you should take into\n account.\n\t\t\t\t

\n \n \n \n " }, "Namespace": { "shape_name": "OptionNamespace", "type": "string", "documentation": "\n

\n " }, "OptionName": { "shape_name": "ConfigurationOptionName", "type": "string", "documentation": "\n

\n " } }, "documentation": "\n

\n An error or warning for a desired configuration option value.\n\t\t

\n " }, "documentation": "\n

\n A list of\n ValidationMessage.\n

\n " } }, "documentation": "\n

Provides a list of validation messages.

\n " }, "errors": [ { "shape_name": "InsufficientPrivilegesException", "type": "structure", "members": {}, "documentation": "\n

Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services

\n " } ], "documentation": "\n

\n Takes a set of configuration settings and either a configuration\n template or environment, and determines whether those values are valid.\n\t\t

\n

\n This action returns a list of messages indicating any errors or warnings\n associated\n with the selection of option values.\n\t\t

\n \n https://elasticbeanstalk.us-east-1.amazon.com/?ApplicationName=SampleApp\n&EnvironmentName=SampleAppVersion\n&OptionSettings.member.1.Namespace=aws%3Aautoscaling%3Atrigger\n&OptionSettings.member.1.OptionName=LowerThreshold\n&OptionSettings.member.1.Value=1000000\n&Operation=ValidateConfigurationSettings\n&AuthParams \n\n \n \n \n \n \n 06f1cfff-f28f-11df-8a78-9f77047e0d0c\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null }, "protocols": [ "https" ] }, "pagination": { "DescribeEvents": { "limit_key": "MaxRecords", "input_token": "NextToken", "output_token": "NextToken", "result_key": "Events", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/elastictranscoder.json0000644000175000017500000335774112254746566022700 0ustar takakitakaki{ "api_version": "2012-09-25", "type": "rest-json", "signature_version": "v4", "service_full_name": "Amazon Elastic Transcoder", "endpoint_prefix": "elastictranscoder", "xmlnamespace": "http://elastictranscoder.amazonaws.com/doc/2012-09-25/", "documentation": "\n AWS Elastic Transcoder Service\n

The AWS Elastic Transcoder Service.

\n ", "operations": { "CancelJob": { "name": "CancelJob", "http": { "method": "DELETE", "uri": "/2012-09-25/jobs/{Id}", "response_code": 202 }, "input": { "shape_name": "CancelJobRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the job that you want to cancel.

\n

To get a list of the jobs (including their jobId) that have a status of\n Submitted, use the ListJobsByStatus API action.

\n ", "location": "uri" } }, "documentation": " \n

The CancelJobRequest structure.

\n " }, "output": { "shape_name": "CancelJobResponse", "type": "structure", "members": {}, "documentation": "\n

The response body contains a JSON object. If the job is successfully canceled, the value\n of Success is true.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\n

The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The CancelJob operation cancels an unfinished job.

\n You can only cancel a job that has a status of Submitted. To prevent a\n pipeline from starting to process a job while you're getting the job identifier, use\n UpdatePipelineStatus to temporarily pause the pipeline.\n \n \n DELETE /2012-09-25/jobs/3333333333333-abcde3 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\n Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" }\n \n \n " }, "CreateJob": { "name": "CreateJob", "http": { "method": "POST", "uri": "/2012-09-25/jobs", "response_code": 201 }, "input": { "shape_name": "CreateJobRequest", "type": "structure", "members": { "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the pipeline that you want Elastic Transcoder to use for\n transcoding. The pipeline determines several settings, including the Amazon S3 bucket\n from which Elastic Transcoder gets the files to transcode and the bucket into which\n Elastic Transcoder puts the transcoded files.

\n " }, "Input": { "shape_name": "JobInput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

\n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

\n " }, "Interlaced": { "shape_name": "Interlaced", "type": "string", "pattern": "(^auto$)|(^true$)|(^false$)", "documentation": "\n

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

true, false

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

\n " }, "Container": { "shape_name": "JobContainer", "type": "string", "pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)", "documentation": "\n

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

\n " } }, "documentation": "\n

A section of the request body that provides information about the file that is being\n transcoded.

\n " }, "Output": { "shape_name": "CreateJobOutput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values: auto, 0,\n 90, 180, 270. The value auto\n generally works only if the file that you're transcoding contains rotation metadata.\n

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

If you specify a preset in PresetId for which the value of\n Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset for the current output.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

The CreateJobOutput structure.

\n ", "cli_name": "job-output" }, "Outputs": { "shape_name": "CreateJobOutputs", "type": "list", "members": { "shape_name": "CreateJobOutput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID. If a file with the specified name already exists in the output bucket,\n the job fails.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values: auto, 0,\n 90, 180, 270. The value auto\n generally works only if the file that you're transcoding contains rotation metadata.\n

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the preset to use for this job. The preset determines the audio,\n video, and thumbnail settings that Elastic Transcoder uses for transcoding.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

If you specify a preset in PresetId for which the value of\n Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset for the current output.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

Information about the album art that you want Elastic Transcoder to add to the file during\n transcoding. You can specify up to twenty album artworks for each output. Settings for each\n artwork must be defined in the job for the current output.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

The CreateJobOutput structure.

\n " }, "max_length": 30, "documentation": "\n

A section of the request body that provides information about the transcoded (target)\n files. We recommend that you use the Outputs syntax instead of the\n Output syntax.

\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The value, if any, that you want Elastic Transcoder to prepend to the names of all files\n that this job creates, including output files, thumbnails, and playlists.

\n " }, "Playlists": { "shape_name": "CreateJobPlaylists", "type": "list", "members": { "shape_name": "CreateJobPlaylist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name objects must be\n unique. Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name, it will appear twice in the file name.

\n " }, "Format": { "shape_name": "PlaylistFormat", "type": "string", "pattern": "(^HLSv3$)", "documentation": "\n

This value must currently be HLSv3.

\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist,\n the value of SegmentDuration for all of the outputs must be the same.

\n " } }, "documentation": "\n

Information about the master playlist.

\n " }, "max_length": 30, "documentation": "\n

If you specify a preset in PresetId for which the value of\n Container is ts (MPEG-TS), Playlists contains information about the\n master playlists that you want Elastic Transcoder to create.

\n

We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.

\n " } }, "documentation": "\n

The CreateJobRequest structure.

\n " }, "output": { "shape_name": "CreateJobResponse", "type": "structure", "members": { "Job": { "shape_name": "Job", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the job.

\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

\n " }, "Input": { "shape_name": "JobInput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

\n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

\n " }, "Interlaced": { "shape_name": "Interlaced", "type": "string", "pattern": "(^auto$)|(^true$)|(^false$)", "documentation": "\n

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

true, false

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

\n " }, "Container": { "shape_name": "JobContainer", "type": "string", "pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)", "documentation": "\n

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

\n " } }, "documentation": "\n

A section of the request or response body that provides information about the file that\n is being transcoded.

\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.

\n

Outputs recommended instead. A section of the request or response\n body that provides information about the transcoded (target) file.

\n " }, "Outputs": { "shape_name": "JobOutputs", "type": "list", "members": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

Outputs recommended instead.If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n Output object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs\n object.

\n " }, "documentation": "\n

Information about the output files. We recommend that you use the Outputs\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs and Output syntaxes in\n the same request. You can create a maximum of 30 outputs per job.

\n

If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.

\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix.

\n " }, "Playlists": { "shape_name": "Playlists", "type": "list", "members": { "shape_name": "Playlist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name, it will appear twice in the file name.

\n " }, "Format": { "shape_name": "PlaylistFormat", "type": "string", "pattern": "(^HLSv3$)", "documentation": "\n

This value must currently be HLSv3.

\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration for all of the outputs must be the same.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job with which the playlist is associated.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains the status.

\n " } }, "documentation": "\n

Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.

\n " }, "documentation": "\n

Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Container is ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.

\n " } }, "documentation": "\n

A section of the response body that provides information about the job that is created.\n

\n " } }, "documentation": "\n

The CreateJobResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

When you create a job, Elastic Transcoder returns JSON data that includes the values\n that you specified plus information about the job that is created.

\n

If you have specified more than one output for your jobs (for example, one output for the\n Kindle Fire and another output for the Apple iPhone 4s), you currently must use the\n Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

\n \n CreateJob Example\n \n POST /2012-09-25/jobs HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Input\":{\n \"Key\":\"recipes/lasagna.mp4\", \"FrameRate\":\"auto\", \"Resolution\":\"auto\",\n \"AspectRatio\":\"auto\", \"Interlaced\":\"auto\", \"Container\":\"mp4\" },\n \"OutputKeyPrefix\":\"recipes/\", \"Outputs\":[ {\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Rotate\":\"0\",\n \"PresetId\":\"1351620000000-100080\" }, { \"Key\":\"iphone/lasagna-1024k\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Rotate\":\"0\",\n \"PresetId\":\"1351620000000-987654\", \"SegmentDuration\":\"5\" }, {\n \"Key\":\"iphone/lasagna-512k\", \"ThumbnailPattern\":\"iphone/th512k/lasagna-{count}\",\n \"Rotate\":\"0\", \"PresetId\":\"1351620000000-456789\", \"Watermarks\":[ {\n \"InputKey\":\"logo/128x64.png\", \"PresetWatermarkId\":\"company logo 128x64\" } ],\n \"SegmentDuration\":\"5\" } ], \"Playlists\": [ { \"Format\": \"HLSv3\", \"Name\":\n \"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\": [ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"PipelineId\":\"1111111111111-abcde1\" } \n Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Job\":{\n \"Id\":\"3333333333333-abcde3\" \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"2\", \"Key\":\"iphone/lasagna-1024k\",\n \"PresetId\":\"1351620000000-987654\", \"Rotate\":\"0\", \"SegmentDuration\":\"5\",\n \"Status\":\"Progressing\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Width\":\"1136\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\", \"Key\":\"iphone/lasagna-512k\",\n \"PresetId\":\"1351620000000-456789\", \"Watermarks\":[ {\n \"InputKey\":\"logo/128x64.png\", \"PresetWatermarkId\":\"company logo 128x64\" } ],\n \"Rotate\":\"0\", \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/lasagna-{count}\", \"Width\":\"1136\" } ],\n \"PipelineId\":\"1111111111111-abcde1\", \"Playlists\":[ { \"Format\":\"HLSv3\",\n \"Name\":\"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\": [ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"Status\":\"Progressing\" } \n \n \n " }, "CreatePipeline": { "name": "CreatePipeline", "http": { "method": "POST", "uri": "/2012-09-25/pipelines", "response_code": 201 }, "input": { "shape_name": "CreatePipelineRequest", "type": "structure", "members": { "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters.

\n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you saved the media files that you want to transcode.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use\n ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

\n

Specify this value when all of the following are true:

\n

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket\n and specify values for ContentConfig and ThumbnailConfig\n instead.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the\n pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

The ThumbnailConfig object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig even if you don't want to create thumbnails.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n \n " } }, "documentation": "\n

The CreatePipelineRequest structure.

\n " }, "output": { "shape_name": "CreatePipelineResponse", "type": "structure", "members": { "Pipeline": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

A section of the response body that provides information about the pipeline that is\n created.

\n " } }, "documentation": "\n

When you create a pipeline, Elastic Transcoder returns the values that you specified in the\n request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The CreatePipeline operation creates a pipeline with settings that you specify.

\n \n \n POST /2012-09-25/pipelines HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"Name\":\"Default\", \"InputBucket\":\"salesoffice.example.com-source\",\n \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Notifications\":{\n \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" } \"ContentConfig\":{\n \"Bucket\": \"My-S3-bucket\", \"Permissions\":[ { \"GranteeType\":\"Email\", \"Grantee\":\n \"marketing-promos@example.com\", \"Access\":[ \"Read\" ] } ],\n \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{ \"Bucket\":\"My-S3-bucket\",\n \"Permissions\":[ { \"GranteeType\":\"Email\",\n \"Grantee\":\"marketing-promos@example.com\", \"Access\":[ \"Read\" ] } ],\n \"StorageClass\":\"Standard\" } }\n Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipeline\":{\n Id\":\"1111111111111-abcde1\", \"InputBucket\":\"salesoffice.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ET_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos@example.com\", \"Access\":[\n \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice.example.com-public-promos-thumbnails\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos@example.com\", \"Access\":[\n \"FullControl\" ] } ], \"StorageClass\":\"ReducedRedundancy\" }, \"Status\":\"Active\" } }\n \n \n \n " }, "CreatePreset": { "name": "CreatePreset", "http": { "method": "POST", "uri": "/2012-09-25/presets", "response_code": 201 }, "input": { "shape_name": "CreatePresetRequest", "type": "structure", "members": { "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the preset. We recommend that the name be unique within the AWS account, but\n uniqueness is not enforced.

\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

A description of the preset.

\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\n

The container type for the output file. Valid values include mp3, \n mp4, ogg, ts, and webm.

\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\n

The video codec for the output file. Valid values include H.264 and\n vp8. You can only specify vp8 when the container type is\n webm.

\n " }, "CodecOptions": { "shape_name": "CodecOptions", "type": "map", "keys": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "members": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

\n Profile\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:

\n

1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n " }, "KeyframesMaxDist": { "shape_name": "KeyframesMaxDist", "type": "string", "pattern": "^\\d{1,6}$", "documentation": "\n

The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.

\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n " }, "BitRate": { "shape_name": "VideoBitRate", "type": "string", "pattern": "(^\\d{2,5}$)|(^auto$)", "documentation": "\n

The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level and Profile. If you specify\n auto, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:

\n

\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n

\n \n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frames per second for the video stream in the output file. Valid values include:

\n

auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n \n " }, "MaxFrameRate": { "shape_name": "MaxFrameRate", "type": "string", "pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10,\n 15, 23.97, 24, 25,\n 29.97, 30, 60.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The width and height of the video in the output file, in pixels. Valid values are\n auto and width x height:

\n \n

Note the following about specifying the width and height:

\n \n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The display aspect ratio of the video in the output file. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.

\n

If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

\n " }, "DisplayAspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The value that Elastic Transcoder adds to the metadata in the output file.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output video:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth\n and MaxHeight.

\n " }, "Watermarks": { "shape_name": "PresetWatermarks", "type": "list", "members": { "shape_name": "PresetWatermark", "type": "structure", "members": { "Id": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": " A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long. " }, "MaxWidth": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum width of the watermark in one of the following formats:

\n " }, "MaxHeight": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum height of the watermark in one of the following formats:

If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.

\n " }, "SizingPolicy": { "shape_name": "WatermarkSizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)", "documentation": "\n

A value that controls scaling of the watermark:

\n

\n " }, "HorizontalAlign": { "shape_name": "HorizontalAlign", "type": "string", "pattern": "(^Left$)|(^Right$)|(^Center$)", "documentation": "\n

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n " }, "HorizontalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

\n " }, "VerticalAlign": { "shape_name": "VerticalAlign", "type": "string", "pattern": "(^Top$)|(^Bottom$)|(^Center$)", "documentation": "\n

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n " }, "VerticalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n VerticalOffset\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

\n " }, "Opacity": { "shape_name": "Opacity", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{0,20})?$", "documentation": "\n

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

\n " }, "Target": { "shape_name": "Target", "type": "string", "pattern": "(^Content$)|(^Frame$)", "documentation": "\n

A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset, VerticalOffset, MaxWidth,\n and MaxHeight:

\n " } }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " } }, "documentation": "\n

A section of the request body that specifies the video parameters.

\n " }, "Audio": { "shape_name": "AudioParameters", "type": "structure", "members": { "Codec": { "shape_name": "AudioCodec", "type": "string", "pattern": "(^AAC$)|(^vorbis$)|(^mp3$)", "documentation": "\n

The audio codec for the output file. Valid values include aac, \n mp3, and vorbis.

\n " }, "SampleRate": { "shape_name": "AudioSampleRate", "type": "string", "pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)", "documentation": "\n

The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:

\n

auto, 22050, 32000, 44100,\n 48000, 96000

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

\n " }, "BitRate": { "shape_name": "AudioBitRate", "type": "string", "pattern": "^\\d{1,3}$", "documentation": "\n

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.

\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\n

The number of audio channels in the output file. Valid values include:

\n

auto, 0, 1, 2

\n

If you specify auto, Elastic Transcoder automatically detects the number of channels in\n the input file.

\n " }, "CodecOptions": { "shape_name": "AudioCodecOptions", "type": "structure", "members": { "Profile": { "shape_name": "AudioCodecProfile", "type": "string", "pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)", "documentation": "\n

If you specified AAC for Audio:Codec, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:

\n \n

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.

 \n " } }, "documentation": "\n

If you specified AAC for Audio:Codec, this is the AAC \n compression profile to use. Valid values include:

\n

auto, AAC-LC, HE-AAC, HE-AACv2

\n

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

\n " } }, "documentation": "\n

A section of the request body that specifies the audio parameters.

\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\n

The number of seconds between thumbnails. Specify an integer value.

\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n width x height where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of thumbnails:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

\n " } }, "documentation": "\n

A section of the request body that specifies the thumbnail parameters, if any.

\n " } }, "documentation": "\n

The CreatePresetRequest structure.

\n " }, "output": { "shape_name": "CreatePresetResponse", "type": "structure", "members": { "Preset": { "shape_name": "Preset", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the preset.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the preset.

\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

A description of the preset.

\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\n

The container type for the output file. Valid values include mp3,\n mp4, ogg, ts, and webm.

\n " }, "Audio": { "shape_name": "AudioParameters", "type": "structure", "members": { "Codec": { "shape_name": "AudioCodec", "type": "string", "pattern": "(^AAC$)|(^vorbis$)|(^mp3$)", "documentation": "\n

The audio codec for the output file. Valid values include aac, \n mp3, and vorbis.

\n " }, "SampleRate": { "shape_name": "AudioSampleRate", "type": "string", "pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)", "documentation": "\n

The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:

\n

auto, 22050, 32000, 44100,\n 48000, 96000

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

\n " }, "BitRate": { "shape_name": "AudioBitRate", "type": "string", "pattern": "^\\d{1,3}$", "documentation": "\n

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.

\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\n

The number of audio channels in the output file. Valid values include:

\n

auto, 0, 1, 2

\n

If you specify auto, Elastic Transcoder automatically detects the number of channels in\n the input file.

\n " }, "CodecOptions": { "shape_name": "AudioCodecOptions", "type": "structure", "members": { "Profile": { "shape_name": "AudioCodecProfile", "type": "string", "pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)", "documentation": "\n

If you specified AAC for Audio:Codec, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:

\n \n

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.

 \n " } }, "documentation": "\n

If you specified AAC for Audio:Codec, this is the AAC \n compression profile to use. Valid values include:

\n

auto, AAC-LC, HE-AAC, HE-AACv2

\n

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

\n " } }, "documentation": "\n

A section of the response body that provides information about the audio preset\n values.

\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\n

The video codec for the output file. Valid values include H.264 and\n vp8. You can only specify vp8 when the container type is\n webm.

\n " }, "CodecOptions": { "shape_name": "CodecOptions", "type": "map", "keys": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "members": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

\n Profile\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:

\n

1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n " }, "KeyframesMaxDist": { "shape_name": "KeyframesMaxDist", "type": "string", "pattern": "^\\d{1,6}$", "documentation": "\n

The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.

\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n " }, "BitRate": { "shape_name": "VideoBitRate", "type": "string", "pattern": "(^\\d{2,5}$)|(^auto$)", "documentation": "\n

The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level and Profile. If you specify\n auto, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:

\n

\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n

\n \n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frames per second for the video stream in the output file. Valid values include:

\n

auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n \n " }, "MaxFrameRate": { "shape_name": "MaxFrameRate", "type": "string", "pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10,\n 15, 23.97, 24, 25,\n 29.97, 30, 60.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The width and height of the video in the output file, in pixels. Valid values are\n auto and width x height:

\n \n

Note the following about specifying the width and height:

\n \n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The display aspect ratio of the video in the output file. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.

\n

If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

\n " }, "DisplayAspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The value that Elastic Transcoder adds to the metadata in the output file.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output video:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth\n and MaxHeight.

\n " }, "Watermarks": { "shape_name": "PresetWatermarks", "type": "list", "members": { "shape_name": "PresetWatermark", "type": "structure", "members": { "Id": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": " A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long. " }, "MaxWidth": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum width of the watermark in one of the following formats:

\n " }, "MaxHeight": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum height of the watermark in one of the following formats:

If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.

\n " }, "SizingPolicy": { "shape_name": "WatermarkSizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)", "documentation": "\n

A value that controls scaling of the watermark:

\n

\n " }, "HorizontalAlign": { "shape_name": "HorizontalAlign", "type": "string", "pattern": "(^Left$)|(^Right$)|(^Center$)", "documentation": "\n

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n " }, "HorizontalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

\n " }, "VerticalAlign": { "shape_name": "VerticalAlign", "type": "string", "pattern": "(^Top$)|(^Bottom$)|(^Center$)", "documentation": "\n

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n " }, "VerticalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n VerticalOffset\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

\n " }, "Opacity": { "shape_name": "Opacity", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{0,20})?$", "documentation": "\n

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

\n " }, "Target": { "shape_name": "Target", "type": "string", "pattern": "(^Content$)|(^Frame$)", "documentation": "\n

A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset, VerticalOffset, MaxWidth,\n and MaxHeight:

\n " } }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " } }, "documentation": "\n

A section of the response body that provides information about the video preset\n values.

\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\n

The number of seconds between thumbnails. Specify an integer value.

\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n width x height where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of thumbnails:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

\n " } }, "documentation": "\n

A section of the response body that provides information about the thumbnail preset\n values, if any.

\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\n

Whether the preset is a default preset provided by Elastic Transcoder\n (System) or a preset that you have defined (Custom).

\n " } }, "documentation": "\n

A section of the response body that provides information about the preset that is\n created.

\n " }, "Warning": { "shape_name": "String", "type": "string", "documentation": "\n

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder\n created the preset, this message explains the reason the preset settings don't meet the\n standard. Elastic Transcoder created the preset because the settings might produce acceptable\n output.

\n " } }, "documentation": "\n

The CreatePresetResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": {}, "documentation": "\n

Too many operations for a given AWS account. For example, the number of pipelines exceeds\n the maximum allowed.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The CreatePreset operation creates a preset with settings that you specify.

\n Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements\n and to determine whether they comply with H.264 standards. If your settings are not\n valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and\n does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly\n compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message\n in the response. This helps you determine whether your settings comply with the H.264\n standard while giving you greater flexibility with respect to the video that Elastic Transcoder\n produces.\n

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International\n Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding\n for generic audiovisual services.

\n \n \n POST /2012-09-25/presets HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"Name\":\"DefaultPreset\", \"Description\":\"Use for published videos\",\n \"Container\":\"mp4\", \"Audio\":{ \"Codec\":\"AAC\", \"SampleRate\":\"44100\",\n \"BitRate\":\"96\", \"Channels\":\"2\" }, \"Video\":{ \"Codec\":\"H.264\", \"CodecOptions\":{\n \"Profile\":\"main\", \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\", \"MaxBitRate\":\"\",\n \"BufferSize\":\"\" }, \"KeyframesMaxDist\":\"240\", \"FixedGOP\":\"false\",\n \"BitRate\":\"1600\", \"FrameRate\":\"30\", \"MaxWidth\": \"auto\", \"MaxHeight\": \"auto\",\n \"SizingPolicy\": \"Fit\", \"PaddingPolicy\": \"NoPad\", \"DisplayAspectRatio\": \"16:9\",\n \"Watermarks\":[ { \"Id\":\"company logo\", \"MaxWidth\":\"20%\", \"MaxHeight\":\"20%\",\n \"SizingPolicy\":\"ShrinkToFit\", \"HorizontalAlign\":\"Right\",\n \"HorizontalOffset\":\"10px\", \"VerticalAlign\":\"Bottom\", \"VerticalOffset\":\"10px\",\n \"Opacity\":\"55.5\", \"Target\":\"Content\" } ]}, \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto, \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\",\n \"PaddingPolicy\": \"NoPad\" } }\n Status: 201 Created x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Preset\":{ \"Audio\":{\n \"BitRate\":\"96\", \"Channels\":\"2\", \"Codec\":\"AAC\", \"SampleRate\":\"44100\" },\n \"Container\":\"mp4\", \"Description\":\"Use for published videos\",\n \"Id\":\"5555555555555-abcde5\", \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto, \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\",\n \"PaddingPolicy\": \"NoPad\" }, \"Type\":\"Custom\", \"Video\":{ \"Codec\":\"H.264\",\n \"CodecOptions\":{ \"Profile\":\"main\", \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\",\n \"MaxBitRate\":\"\", \"BufferSize\":\"\" }, \"KeyframesMaxDist\":\"240\",\n \"FixedGOP\":\"false\", \"BitRate\":\"1600\", \"FrameRate\":\"30\", \"MaxWidth\": \"auto\",\n \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fit\", \"PaddingPolicy\": \"NoPad\",\n \"DisplayAspectRatio\": \"16:9\", \"Watermarks\":[ { \"Id\":\"company logo\",\n \"MaxWidth\":\"20%\", \"MaxHeight\":\"20%\", \"SizingPolicy\":\"ShrinkToFit\",\n \"HorizontalAlign\":\"Right\", \"HorizontalOffset\":\"10px\", \"VerticalAlign\":\"Bottom\",\n \"VerticalOffset\":\"10px\", \"Opacity\":\"55.5\", \"Target\":\"Content\" } ] } },\n \"Warning\":\"\" }\n \n \n " }, "DeletePipeline": { "name": "DeletePipeline", "http": { "method": "DELETE", "uri": "/2012-09-25/pipelines/{Id}", "response_code": 202 }, "input": { "shape_name": "DeletePipelineRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the pipeline that you want to delete.

\n ", "location": "uri" } }, "documentation": "\n

The DeletePipelineRequest structure.

\n " }, "output": { "shape_name": "DeletePipelineResponse", "type": "structure", "members": {}, "documentation": "\n

The DeletePipelineResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\n

The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The DeletePipeline operation removes a pipeline.

\n

You can only delete a pipeline that has never been used or that is not currently in use\n (doesn't contain any active jobs). If the pipeline is currently in use,\n DeletePipeline returns an error.

\n \n \n DELETE /2012-09-25/pipelines/1111111111111-abcde1 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\n Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" } \n \n \n " }, "DeletePreset": { "name": "DeletePreset", "http": { "method": "DELETE", "uri": "/2012-09-25/presets/{Id}", "response_code": 202 }, "input": { "shape_name": "DeletePresetRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the preset for which you want to get detailed information.

\n ", "location": "uri" } }, "documentation": "\n

The DeletePresetRequest structure.

\n " }, "output": { "shape_name": "DeletePresetResponse", "type": "structure", "members": {}, "documentation": "\n

The DeletePresetResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The DeletePreset operation removes a preset that you've added in an AWS region.

\n \n

You can't delete the default presets that are included with Elastic Transcoder.

\n \n \n \n DELETE /2012-09-25/pipelines/5555555555555-abcde5 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Success\":\"true\" }\n \n \n " }, "ListJobsByPipeline": { "name": "ListJobsByPipeline", "http": { "method": "GET", "uri": "/2012-09-25/jobsByPipeline/{PipelineId}?Ascending={Ascending}&PageToken={PageToken}" }, "input": { "shape_name": "ListJobsByPipelineRequest", "type": "structure", "members": { "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The ID of the pipeline for which you want to get job information.

\n ", "location": "uri" }, "Ascending": { "shape_name": "Ascending", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

To list jobs in chronological order by the date and time that they were submitted, enter\n true. To list jobs in reverse chronological order, enter\n false.

\n ", "location": "uri" }, "PageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

\n ", "location": "uri" } }, "documentation": "\n

The ListJobsByPipelineRequest structure.

\n " }, "output": { "shape_name": "ListJobsByPipelineResponse", "type": "structure", "members": { "Jobs": { "shape_name": "Jobs", "type": "list", "members": { "shape_name": "Job", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the job.

\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

\n " }, "Input": { "shape_name": "JobInput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

\n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

\n " }, "Interlaced": { "shape_name": "Interlaced", "type": "string", "pattern": "(^auto$)|(^true$)|(^false$)", "documentation": "\n

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

true, false

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

\n " }, "Container": { "shape_name": "JobContainer", "type": "string", "pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)", "documentation": "\n

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

\n " } }, "documentation": "\n

A section of the request or response body that provides information about the file that\n is being transcoded.

\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.

\n

Outputs recommended instead. A section of the request or response\n body that provides information about the transcoded (target) file.

\n " }, "Outputs": { "shape_name": "JobOutputs", "type": "list", "members": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

Outputs recommended instead.If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n Output object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs\n object.

\n " }, "documentation": "\n

Information about the output files. We recommend that you use the Outputs\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs and Output syntaxes in\n the same request. You can create a maximum of 30 outputs per job.

\n

If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.

\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix.

\n " }, "Playlists": { "shape_name": "Playlists", "type": "list", "members": { "shape_name": "Playlist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name, it will appear twice in the file name.

\n " }, "Format": { "shape_name": "PlaylistFormat", "type": "string", "pattern": "(^HLSv3$)", "documentation": "\n

This value must currently be HLSv3.

\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration for all of the outputs must be the same.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job with which the playlist is associated.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains the status.

\n " } }, "documentation": "\n

Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.

\n " }, "documentation": "\n

Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Container is ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.

\n " } }, "documentation": "\n

A section of the response body that provides information about the job that is\n created.

\n " }, "documentation": "\n

An array of Job objects that are in the specified pipeline.

\n " }, "NextPageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

A value that you use to access the second and subsequent pages of results, if any. When\n the jobs in the specified pipeline fit on one page or when you've reached the last page\n of results, the value of NextPageToken is null.

\n " } }, "documentation": "\n

The ListJobsByPipelineResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

\n

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The\n response body contains one element for each job that satisfies the search criteria.

\n \n \n GET /2012-09-25/jobsByPipeline/1111111111111-abcde1?Ascending=true HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Jobs\":[ { \"Id\":\"3333333333333-abcde3\",\n \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\", \"Resolution\":\"auto\" },\n \"Outputs \":[ { \"Id\":\"1\" \"Key\":\"cooking/lasagna-KindleFireHD.mp4\",\n \"PresetId\":\"5555555555555-abcde5\", \"Rotate\":\"0\", \"Status\":\"Submitted\",\n \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-KindleFireHD\", \"Duration\":\"1003\",\n \"Width\":\"1280\", \"Height\":\"720\" }, { \"Id\":\"2\"\n \"Key\":\"cooking/lasagna-iPhone4s.mp4\", \"PresetId\":\"1351620000000-100020\",\n \"Rotate\":\"0\", \"Status\":\"Submitted\", \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-iPhone4s\", \"Duration\":\"1003\",\n \"Width\":\"1920\", \"Height\":\"1080\" } ], \"Output\":{\n \"Key\":\"cooking/lasagna-KindleFireHD.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Submitted\", \"StatusDetail\":\"Job has been received.\",\n \"ThumbnailPattern\":\"cooking/lasagna-{count}-KindleFireHD\" },\n \"PipelineId\":\"1111111111111-abcde1\" }, { \"Id\":\"4444444444444-abcde4\", \"Input\":{\n \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/baked-ziti.mp4\", \"Resolution\":\"auto\" },\n \"Outputs\":[ { \"Id\":\"1\" \"Key\":\"cooking/baked-ziti-KindleFireHD.mp4\",\n \"PresetId\":\"1351620000000-100080\", \"Rotate\":\"0\", \"Status\":\"Complete\",\n \"StatusDetail\":\"\", \"ThumbnailPattern\":\"cooking/baked-ziti-{count}-KindleFireHD\",\n \"Duration\":\"596\", \"Width\":\"1280\", \"Height\":\"720\" } ], \"Output\":{\n \"Key\":\"cooking/baked-ziti-KindleFireHD.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"cooking/baked-ziti-{count}-KindleFireHD\" },\n \"PipelineId\":\"1111111111111-abcde1\" } ], \"NextPageToken\":null \n \n \n ", "pagination": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs", "py_input_token": "page_token" } }, "ListJobsByStatus": { "name": "ListJobsByStatus", "http": { "method": "GET", "uri": "/2012-09-25/jobsByStatus/{Status}?Ascending={Ascending}&PageToken={PageToken}" }, "input": { "shape_name": "ListJobsByStatusRequest", "type": "structure", "members": { "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

To get information about all of the jobs associated with the current AWS account that\n have a given status, specify the following status: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n ", "location": "uri" }, "Ascending": { "shape_name": "Ascending", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

To list jobs in chronological order by the date and time that they were submitted, enter\n true. To list jobs in reverse chronological order, enter\n false.

\n ", "location": "uri" }, "PageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

\n ", "location": "uri" } }, "documentation": "\n

The ListJobsByStatusRequest structure.

\n " }, "output": { "shape_name": "ListJobsByStatusResponse", "type": "structure", "members": { "Jobs": { "shape_name": "Jobs", "type": "list", "members": { "shape_name": "Job", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the job.

\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

\n " }, "Input": { "shape_name": "JobInput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

\n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

\n " }, "Interlaced": { "shape_name": "Interlaced", "type": "string", "pattern": "(^auto$)|(^true$)|(^false$)", "documentation": "\n

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

true, false

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

\n " }, "Container": { "shape_name": "JobContainer", "type": "string", "pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)", "documentation": "\n

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

\n " } }, "documentation": "\n

A section of the request or response body that provides information about the file that\n is being transcoded.

\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.

\n

Outputs recommended instead. A section of the request or response\n body that provides information about the transcoded (target) file.

\n " }, "Outputs": { "shape_name": "JobOutputs", "type": "list", "members": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

Outputs recommended instead.If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n Output object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs\n object.

\n " }, "documentation": "\n

Information about the output files. We recommend that you use the Outputs\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs and Output syntaxes in\n the same request. You can create a maximum of 30 outputs per job.

\n

If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.

\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix.

\n " }, "Playlists": { "shape_name": "Playlists", "type": "list", "members": { "shape_name": "Playlist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name, it will appear twice in the file name.

\n " }, "Format": { "shape_name": "PlaylistFormat", "type": "string", "pattern": "(^HLSv3$)", "documentation": "\n

This value must currently be HLSv3.

\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration for all of the outputs must be the same.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job with which the playlist is associated.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains the status.

\n " } }, "documentation": "\n

Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.

\n " }, "documentation": "\n

Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Container is ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.

\n " } }, "documentation": "\n

A section of the response body that provides information about the job that is\n created.

\n " }, "documentation": "\n

An array of Job objects that have the specified status.

\n " }, "NextPageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

A value that you use to access the second and subsequent pages of results, if any. When\n the jobs in the specified pipeline fit on one page or when you've reached the last page\n of results, the value of NextPageToken is null.

\n " } }, "documentation": "\n

\n The ListJobsByStatusResponse structure.\n

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ListJobsByStatus operation gets a list of jobs that have a specified status. The\n response body contains one element for each job that satisfies the search criteria.

\n \n \n GET /2012-09-25/jobsByStatus/Complete?Ascending=true HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Jobs\":[ {\n \"Id\":\"3333333333333-abcde3\", \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"720\", \"Id\":\"1\",\n \"Key\":\"mp4/lasagna-kindlefirehd.mp4\", \"PresetId\":\"1351620000000-100080\",\n \"Rotate\":\"0\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"mp4/thumbnails/lasagna-{count}\", \"Width\":\"1280\" }, {\n \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"2\", \"Key\":\"iphone/lasagna-1024k\",\n \"PresetId\":\"1351620000000-987654\", \"Rotate\":\"0\", \"SegmentDuration\":\"5\",\n \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th1024k/lasagna-{count}\", \"Width\":\"1136\" }, ],\n \"PipelineId\":\"1111111111111-abcde1\", \"Playlists\":[ { \"Format\":\"HLSv3\",\n \"Name\":\"playlist-iPhone-lasagna.m3u8\", \"OutputKeys\":[ \"iphone/lasagna-1024k\",\n \"iphone/lasagna-512k\" ] } ], \"Status\":\"Complete\" }, {\n \"Id\":\"4444444444444-abcde4\", \"Input\":{ \"AspectRatio\":\"auto\", \"Container\":\"mp4\",\n \"FrameRate\":\"auto\", \"Interlaced\":\"auto\", \"Key\":\"cooking/spaghetti.mp4\",\n \"Resolution\":\"auto\" }, \"Output\":{ \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\",\n \"Key\":\"iphone/spaghetti-512k\", \"PresetId\":\"1351620000000-456789\", \"Rotate\":\"0\",\n \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/spaghetti-{count}\", \"Width\":\"1136\" },\n \"Outputs\":[ { \"Duration\":\"1003\", \"Height\":\"640\", \"Id\":\"3\",\n \"Key\":\"iphone/spaghetti-512k\", \"PresetId\":\"1351620000000-456789\", \"Rotate\":\"0\",\n \"SegmentDuration\":\"5\", \"Status\":\"Complete\", \"StatusDetail\":\"\",\n \"ThumbnailPattern\":\"iphone/th512k/spaghetti-{count}\", \"Width\":\"1136\" } ],\n \"Playlists\":[ { \"Format\":\"HLSv3\", \"Name\":\"playlist-iPhone-spaghetti.m3u8\",\n \"OutputKeys\":[ \"iphone/spaghetti-512k\" ] } ], \"Status\":\"Complete\" } ],\n \"NextPageToken\":null }\n \n \n ", "pagination": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs", "py_input_token": "page_token" } }, "ListPipelines": { "name": "ListPipelines", "http": { "method": "GET", "uri": "/2012-09-25/pipelines?Ascending={Ascending}&PageToken={PageToken}" }, "input": { "shape_name": "ListPipelinesRequest", "type": "structure", "members": { "Ascending": { "shape_name": "Ascending", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

To list pipelines in chronological order by the date and time that they were created, enter\n true. To list pipelines in reverse chronological order, enter\n false.

\n ", "location": "uri" }, "PageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

\n ", "location": "uri" } }, "documentation": "\n

The ListPipelineRequest structure.

\n " }, "output": { "shape_name": "ListPipelinesResponse", "type": "structure", "members": { "Pipelines": { "shape_name": "Pipelines", "type": "list", "members": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

The pipeline (queue) that is used to manage jobs.

\n " }, "documentation": "\n

An array of Pipeline objects.

\n " }, "NextPageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

A value that you use to access the second and subsequent pages of results, if any. When\n the pipelines fit on one page or when you've reached the last page\n of results, the value of NextPageToken is null.

\n " } }, "documentation": "\n

A list of the pipelines associated with the current AWS account.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ListPipelines operation gets a list of the pipelines associated with the current AWS\n account.

\n \n \n GET /2012-09-25/pipelines HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipelines\":[ {\n \"Id\":\"1111111111111-abcde1\", \"Name\":\"Tokyo-Default\",\n \"InputBucket\":\"salesoffice-tokyo.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Notifications\":{ \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice-tokyo.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-tokyo@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice-tokyo.example.com-public-promos-thumbnails\",\n \"Permissions\":[ { \"GranteeType\":\"Email\",\n \"Grantee\":\"marketing-promos-tokyo@example.com\", \"Access\":[ \"FullControl\" ] } ],\n \"StorageClass\":\"ReducedRedundancy\" }, \"Status\":\"Active\" }, {\n \"Id\":\"2222222222222-abcde2\", \"Name\":\"Amsterdam-Default\",\n \"InputBucket\":\"salesoffice-amsterdam.example.com-source\",\n \"Role\":\"arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role\",\n \"Notifications\":{ \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" }, \"ContentConfig\":{\n \"Bucket\":\"salesoffice-amsterdam.example.com-public-promos\", \"Permissions\":[ {\n \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-amsterdam@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"Standard\" }, nails\",\n \"ThumbnailConfig\":{\n \"Bucket\":\"salesoffice-amsterdam.example.com-public-promos-thumb \"Permissions\":[\n { \"GranteeType\":\"Email\", \"Grantee\":\"marketing-promos-amsterdam@example.com\",\n \"Access\":[ \"FullControl\" ] } ], \"StorageClass\":\"ReducedRedundancy\" },\n \"Status\":\"Active\" } ] } \n \n \n ", "pagination": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Pipelines", "py_input_token": "page_token" } }, "ListPresets": { "name": "ListPresets", "http": { "method": "GET", "uri": "/2012-09-25/presets?Ascending={Ascending}&PageToken={PageToken}" }, "input": { "shape_name": "ListPresetsRequest", "type": "structure", "members": { "Ascending": { "shape_name": "Ascending", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

To list presets in chronological order by the date and time that they were created, enter\n true. To list presets in reverse chronological order, enter\n false.

\n ", "location": "uri" }, "PageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

When Elastic Transcoder returns more than one page of results, use pageToken in\n subsequent GET requests to get each successive page of results.

\n ", "location": "uri" } }, "documentation": "\n

The ListPresetsRequest structure.

\n " }, "output": { "shape_name": "ListPresetsResponse", "type": "structure", "members": { "Presets": { "shape_name": "Presets", "type": "list", "members": { "shape_name": "Preset", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the preset.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the preset.

\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

A description of the preset.

\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\n

The container type for the output file. Valid values include mp3,\n mp4, ogg, ts, and webm.

\n " }, "Audio": { "shape_name": "AudioParameters", "type": "structure", "members": { "Codec": { "shape_name": "AudioCodec", "type": "string", "pattern": "(^AAC$)|(^vorbis$)|(^mp3$)", "documentation": "\n

The audio codec for the output file. Valid values include aac, \n mp3, and vorbis.

\n " }, "SampleRate": { "shape_name": "AudioSampleRate", "type": "string", "pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)", "documentation": "\n

The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:

\n

auto, 22050, 32000, 44100,\n 48000, 96000

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

\n " }, "BitRate": { "shape_name": "AudioBitRate", "type": "string", "pattern": "^\\d{1,3}$", "documentation": "\n

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.

\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\n

The number of audio channels in the output file. Valid values include:

\n

auto, 0, 1, 2

\n

If you specify auto, Elastic Transcoder automatically detects the number of channels in\n the input file.

\n " }, "CodecOptions": { "shape_name": "AudioCodecOptions", "type": "structure", "members": { "Profile": { "shape_name": "AudioCodecProfile", "type": "string", "pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)", "documentation": "\n

If you specified AAC for Audio:Codec, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:

\n \n

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.

 \n " } }, "documentation": "\n

If you specified AAC for Audio:Codec, this is the AAC \n compression profile to use. Valid values include:

\n

auto, AAC-LC, HE-AAC, HE-AACv2

\n

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

\n " } }, "documentation": "\n

A section of the response body that provides information about the audio preset\n values.

\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\n

The video codec for the output file. Valid values include H.264 and\n vp8. You can only specify vp8 when the container type is\n webm.

\n " }, "CodecOptions": { "shape_name": "CodecOptions", "type": "map", "keys": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "members": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

\n Profile\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:

\n

1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n " }, "KeyframesMaxDist": { "shape_name": "KeyframesMaxDist", "type": "string", "pattern": "^\\d{1,6}$", "documentation": "\n

The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.

\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n " }, "BitRate": { "shape_name": "VideoBitRate", "type": "string", "pattern": "(^\\d{2,5}$)|(^auto$)", "documentation": "\n

The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level and Profile. If you specify\n auto, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:

\n

\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n

\n \n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frames per second for the video stream in the output file. Valid values include:

\n

auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n \n " }, "MaxFrameRate": { "shape_name": "MaxFrameRate", "type": "string", "pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10,\n 15, 23.97, 24, 25,\n 29.97, 30, 60.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The width and height of the video in the output file, in pixels. Valid values are\n auto and width x height:

\n \n

Note the following about specifying the width and height:

\n \n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The display aspect ratio of the video in the output file. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.

\n

If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

\n " }, "DisplayAspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The value that Elastic Transcoder adds to the metadata in the output file.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output video:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth\n and MaxHeight.

\n " }, "Watermarks": { "shape_name": "PresetWatermarks", "type": "list", "members": { "shape_name": "PresetWatermark", "type": "structure", "members": { "Id": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": " A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long. " }, "MaxWidth": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum width of the watermark in one of the following formats:

\n " }, "MaxHeight": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum height of the watermark in one of the following formats:

If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.

\n " }, "SizingPolicy": { "shape_name": "WatermarkSizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)", "documentation": "\n

A value that controls scaling of the watermark:

\n

\n " }, "HorizontalAlign": { "shape_name": "HorizontalAlign", "type": "string", "pattern": "(^Left$)|(^Right$)|(^Center$)", "documentation": "\n

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n " }, "HorizontalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

\n " }, "VerticalAlign": { "shape_name": "VerticalAlign", "type": "string", "pattern": "(^Top$)|(^Bottom$)|(^Center$)", "documentation": "\n

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n " }, "VerticalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n VerticalOffset\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

\n " }, "Opacity": { "shape_name": "Opacity", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{0,20})?$", "documentation": "\n

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

\n " }, "Target": { "shape_name": "Target", "type": "string", "pattern": "(^Content$)|(^Frame$)", "documentation": "\n

A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset, VerticalOffset, MaxWidth,\n and MaxHeight:

\n " } }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " } }, "documentation": "\n

A section of the response body that provides information about the video preset\n values.

\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\n

The number of seconds between thumbnails. Specify an integer value.

\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n width x height where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of thumbnails:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

\n " } }, "documentation": "\n

A section of the response body that provides information about the thumbnail preset\n values, if any.

\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\n

Whether the preset is a default preset provided by Elastic Transcoder\n (System) or a preset that you have defined (Custom).

\n " } }, "documentation": "\n

Presets are templates that contain most of the settings for transcoding media files from\n one format to another. Elastic Transcoder includes some default presets for common formats, for\n example, several iPod and iPhone versions. You can also create your own presets for\n formats that aren't included among the default presets. You specify which preset you\n want to use when you create a job.

\n " }, "documentation": "\n

An array of Preset objects.

\n " }, "NextPageToken": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

A value that you use to access the second and subsequent pages of results, if any. When\n the presets fit on one page or when you've reached the last page\n of results, the value of NextPageToken is null.

\n " } }, "documentation": "\n

The ListPresetsResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the\n presets that you've added in an AWS region.

\n \n \n GET /2012-09-25/presets HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Presets\":[ { \"Audio\":{ \"BitRate\":\"96\",\n \"Channels\":\"2\", \"Codec\":\"AAC\", \"SampleRate\":\"44100\" }, \"Container\":\"mp4\",\n \"Description\":\"Use for published videos\", \"Id\":\"5555555555555-abcde5\",\n \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\", \"Interval\":\"120\",\n \"MaxHeight\":\"auto\", \"MaxWidth\":\"auto\", \"PaddingPolicy\":\"Pad\",\n \"SizingPolicy\":\"Fit\" }, \"Type\":\"Custom\", \"Video\":{ \"BitRate\":\"1600\",\n \"Codec\":\"H.264\", \"CodecOptions\":{ \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\",\n \"Profile\":\"main\", \"MaxBitRate\":\"\", \"BufferSize\":\"\" },\n \"DisplayAspectRatio\":\"auto\", \"FixedGOP\":\"false\", \"FrameRate\":\"30\",\n \"KeyframesMaxDist\":\"240\", \"MaxHeight\":\"auto\", \"MaxWidth\":\"auto\",\n \"PaddingPolicy\":\"Pad\", \"SizingPolicy\":\"Fit\" } }, {...} ] } \n \n \n ", "pagination": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Presets", "py_input_token": "page_token" } }, "ReadJob": { "name": "ReadJob", "http": { "method": "GET", "uri": "/2012-09-25/jobs/{Id}" }, "input": { "shape_name": "ReadJobRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the job for which you want to get detailed information.

\n ", "location": "uri" } }, "documentation": "\n

The ReadJobRequest structure.

\n " }, "output": { "shape_name": "ReadJobResponse", "type": "structure", "members": { "Job": { "shape_name": "Job", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the job.

\n " }, "PipelineId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The\n pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the\n files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

\n " }, "Input": { "shape_name": "JobInput", "type": "structure", "members": { "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID\n of the pipeline to use for processing the job. The InputBucket object in\n that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

\n

If the file name includes a prefix, such as cooking/lasagna.mpg, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

\n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate\n of the input file, specify auto. If you want to specify the frame rate for\n the input file, enter one of the following values:

\n

\n 10, 15, 23.97, 24, 25,\n 29.97, 30, 60\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n the frame rate.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n

This value must be auto, which causes Elastic Transcoder to automatically\n detect the resolution of the input file.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect\n ratio of the input file, specify auto. If you want to specify the aspect\n ratio for the output file, enter one of the following values:

\n

\n 1:1, 4:3, 3:2, 16:9\n

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection\n of the aspect ratio.

\n " }, "Interlaced": { "shape_name": "Interlaced", "type": "string", "pattern": "(^auto$)|(^true$)|(^false$)", "documentation": "\n

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether\n the input file is interlaced, specify auto. If you want to specify whether\n the input file is interlaced, enter one of the following values:

\n

true, false

\n

If you specify a value other than auto, Elastic Transcoder disables automatic detection of\n interlacing.

\n " }, "Container": { "shape_name": "JobContainer", "type": "string", "pattern": "(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)", "documentation": "\n

The container type for the input file. If you want Elastic Transcoder to automatically detect the\n container type of the input file, specify auto. If you want to specify the\n container type for the input file, enter one of the following values:

\n

\n 3gp, aac, asf, avi, \n divx, flv, m4a, mkv, \n mov, mp3, mp4, mpeg, \n mpeg-ps, mpeg-ts, mxf, ogg, \n vob, wav, webm\n

\n " } }, "documentation": "\n

A section of the request or response body that provides information about the file that\n is being transcoded.

\n " }, "Output": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

If you specified one output for a job, information about that output. If you specified\n multiple outputs for a job, the Output object lists information about the first output.\n This duplicates the information that is listed for the first output in the Outputs\n object.

\n

Outputs recommended instead. A section of the request or response\n body that provides information about the transcoded (target) file.

\n " }, "Outputs": { "shape_name": "JobOutputs", "type": "list", "members": { "shape_name": "JobOutput", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

A sequential counter, starting with 1, that identifies an output among the outputs from\n the current job. In the Output syntax, this value is always 1.

\n " }, "Key": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket\n specified by the OutputBucket object in the pipeline that is specified by\n the pipeline ID.

\n " }, "ThumbnailPattern": { "shape_name": "ThumbnailPattern", "type": "string", "pattern": "(^$)|(^.*\\{count\\}.*$)", "documentation": "\n

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder\n to name the files.

\n

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

\n

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to\n include in the file name for each thumbnail. You can specify the following values in any\n sequence:

\n \n

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png)\n that appears in the preset that you specified in the PresetID value of\n CreateJobOutput. Elastic Transcoder also appends the applicable file name\n extension.

\n " }, "Rotate": { "shape_name": "Rotate", "type": "string", "pattern": "(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)", "documentation": "\n

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to\n the input. Enter one of the following values:

\n

auto, 0, 90, 180,\n 270

\n

The value auto generally works only if the file that you're transcoding\n contains rotation metadata.

\n " }, "PresetId": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The value of the Id object for the preset that you want to use for this job.\n The preset determines the audio, video, and thumbnail settings that Elastic Transcoder\n uses for transcoding. To use a preset that you created, specify the preset ID that\n Elastic Transcoder returned in the response when you created the preset. You can also\n use the Elastic Transcoder system presets, which you can get with ListPresets.

\n " }, "SegmentDuration": { "shape_name": "Float", "type": "string", "pattern": "^\\d{1,5}(\\.\\d{0,5})?$", "documentation": "\n

(Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Containeris\n ts (MPEG-TS), SegmentDuration is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by SegmentDuration, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n OutputKeys.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of one output in a job. If you specified only one output for the job,\n Outputs:Status is always the same as Job:Status. If you\n specified more than one output:

The value of Status is one of the following: Submitted,\n Progressing, Complete, Canceled, or\n Error.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains Status.

\n " }, "Duration": { "shape_name": "NullableLong", "type": "long", "documentation": "\n

Duration of the output file, in seconds.

\n " }, "Width": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Specifies the width of the output file in pixels.

\n " }, "Height": { "shape_name": "NullableInteger", "type": "integer", "documentation": "\n

Height of the output file, in pixels.

\n " }, "Watermarks": { "shape_name": "JobWatermarks", "type": "list", "members": { "shape_name": "JobWatermark", "type": "structure", "members": { "PresetWatermarkId": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the\n video during transcoding. The settings are in the preset specified by Preset for the\n current output. In that preset, the value of Watermarks Id tells Elastic Transcoder\n which settings to use.

\n " }, "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the .png or .jpg file that you want to use for the watermark. To determine\n which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by\n Pipeline; the Input Bucket object in that pipeline\n identifies the bucket.

\n

If the file name includes a prefix, for example, logos/128x64.png, include the\n prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns\n an error.

\n " } }, "documentation": "\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n " }, "documentation": "\n

Information about the watermarks that you want Elastic Transcoder to add to the video during\n transcoding. You can specify up to four watermarks for each output. Settings for each\n watermark must be defined in the preset that you specify in Preset for the\n current output.

\n

Watermarks are added to the output video in the sequence in which you list them in the\n job output—the first watermark in the list is added to the output video first, the\n second watermark in the list is added next, and so on. As a result, if the settings in a\n preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark\n that you add will cover the first one, the third one will cover the second, and the\n fourth one will cover the third.

\n " }, "AlbumArt": { "shape_name": "JobAlbumArt", "type": "structure", "members": { "MergePolicy": { "shape_name": "MergePolicy", "type": "string", "pattern": "(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)", "documentation": "\n

A policy that determines how Elastic Transcoder will handle the existence of multiple album artwork files.

\n

\n

\n

\n " }, "Artwork": { "shape_name": "Artworks", "type": "list", "members": { "shape_name": "Artwork", "type": "structure", "members": { "InputKey": { "shape_name": "WatermarkKey", "type": "string", "min_length": 1, "max_length": 255, "pattern": "(^.{1,}.jpg$)|(^.{1,}.jpeg$)|(^.{1,}.png$)", "documentation": "\n

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the \n specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the \n InputBucket object in that pipeline identifies the bucket.

\n

If the file name includes a prefix, for example, cooking/pie.jpg,\n include the prefix in the key. If the file isn't in the specified bucket, \n Elastic Transcoder returns an error.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 4096, inclusive.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder \n uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 \n and 3072, inclusive.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output album art:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the \n top and bottom and/or left and right sides of the output album art to make the total size of \n the output art match the values that you specified for MaxWidth and \n MaxHeight.

\n " }, "AlbumArtFormat": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of album art, if any. Valid formats are .jpg and .png.

\n " } }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20.

\n

To remove artwork or leave the artwork empty, you can either set Artwork\n to null, or set the Merge Policy to \"Replace\" and use an empty\n Artwork array.

\n

To pass through existing artwork unchanged, set the Merge Policy to\n \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

\n " }, "documentation": "\n

The file to be used as album art. There can be multiple artworks associated with an audio file, \n to a maximum of 20. Valid formats are .jpg and .png

\n " } }, "documentation": "\n

The album art to be associated with the output file, if any.

\n " }, "Composition": { "shape_name": "Composition", "type": "list", "members": { "shape_name": "Clip", "type": "structure", "members": { "TimeSpan": { "shape_name": "TimeSpan", "type": "structure", "members": { "StartTime": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

\n " }, "Duration": { "shape_name": "Time", "type": "string", "pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)", "documentation": "\n

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.

\n

If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.

\n " } }, "documentation": "\n

Settings that determine when a clip begins and how long it lasts.

\n " } }, "documentation": "\n

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

\n " }, "documentation": "\n

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

\n " } }, "documentation": "\n

Outputs recommended instead.If you specified one output for a job,\n information about that output. If you specified multiple outputs for a job, the\n Output object lists information about the first output. This duplicates\n the information that is listed for the first output in the Outputs\n object.

\n " }, "documentation": "\n

Information about the output files. We recommend that you use the Outputs\n syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only\n one format. Do not use both the Outputs and Output syntaxes in\n the same request. You can create a maximum of 30 outputs per job.

\n

If you specify more than one output for a job, Elastic Transcoder creates the files for\n each output in the order in which you specify them in the job.

\n " }, "OutputKeyPrefix": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job\n creates, including output files, thumbnails, and playlists. We recommend that you add a\n / or some other delimiter to the end of the OutputKeyPrefix.

\n " }, "Playlists": { "shape_name": "Playlists", "type": "list", "members": { "shape_name": "Playlist", "type": "structure", "members": { "Name": { "shape_name": "Filename", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The name that you want Elastic Transcoder to assign to the master playlist, for example,\n nyc-vacation.m3u8. The name cannot include a / character. If you create more than one\n master playlist (not recommended), the values of all Name objects must be\n unique. Note: Elastic Transcoder automatically appends .m3u8 to the file name. If you include\n .m3u8 in Name, it will appear twice in the file name.

\n " }, "Format": { "shape_name": "PlaylistFormat", "type": "string", "pattern": "(^HLSv3$)", "documentation": "\n

This value must currently be HLSv3.

\n " }, "OutputKeys": { "shape_name": "OutputKeys", "type": "list", "members": { "shape_name": "Key", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

For each output in this job that you want to include in a master playlist, the value of\n the Outputs:Key object. If you include more than one output in a playlist, the value of\n SegmentDuration for all of the outputs must be the same.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job with which the playlist is associated.

\n " }, "StatusDetail": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

Information that further explains the status.

\n " } }, "documentation": "\n

Use Only for MPEG-TS Outputs. If you specify a preset for which the value of Container\n is ts (MPEG-TS), Playlists contains information about the master playlists\n that you want Elastic Transcoder to create. We recommend that you create only one master\n playlist. The maximum number of master playlists in a job is 30.

\n " }, "documentation": "\n

Outputs in MPEG-TS format only.If you specify a preset in\n PresetId for which the value of Container is ts (MPEG-TS),\n Playlists contains information about the master playlists that you want\n Elastic Transcoder to create.

\n

We recommend that you create only one master playlist. The maximum number of master\n playlists in a job is 30.

\n " }, "Status": { "shape_name": "JobStatus", "type": "string", "pattern": "(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)", "documentation": "\n

The status of the job: Submitted, Progressing, Complete,\n Canceled, or Error.

\n " } }, "documentation": "\n

A section of the response body that provides information about the job.

\n " } }, "documentation": "\n

The ReadJobResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ReadJob operation returns detailed information about a job.

\n \n \n GET /2012-09-25/jobs/3333333333333-abcde3 HTTP/1.1 Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Job\":{ \"Id\":\"3333333333333-abcde3\", \"Input\":{\n \"AspectRatio\":\"auto\", \"Container\":\"mp4\", \"FrameRate\":\"auto\",\n \"Interlaced\":\"auto\", \"Key\":\"cooking/lasagna.mp4\", \"Resolution\":\"auto\" },\n \"Output\":{ \"Key\":\"\", \"PresetId\":\"5555555555555-abcde5\", \"Rotate\":\"0\",\n \"Status\":\"Submitted\", \"StatusDetail\":\"\", \"ThumbnailPattern\":\"{count}\" },\n \"PipelineId\":\"1111111111111-abcde1\" } }\n \n \n " }, "ReadPipeline": { "name": "ReadPipeline", "http": { "method": "GET", "uri": "/2012-09-25/pipelines/{Id}" }, "input": { "shape_name": "ReadPipelineRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the pipeline to read.

\n ", "location": "uri" } }, "documentation": "\n

The ReadPipelineRequest structure.

\n " }, "output": { "shape_name": "ReadPipelineResponse", "type": "structure", "members": { "Pipeline": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

A section of the response body that provides information about the pipeline.

\n " } }, "documentation": "\n

The ReadPipelineResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ReadPipeline operation gets detailed information about a pipeline.

\n \n \n GET /2012-09-25/pipelines/1111111111111-abcde1 HTTP/1.1\n Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] \n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Pipeline\":{ \"Id\":\"1111111111111-abcde1\",\n \"InputBucket\":\"salesoffice.example.com-source\", \"Name\":\"Default\",\n \"Notifications\":{ \"Completed\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" }, \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Status\":\"Active\" }\n }\n \n \n " }, "ReadPreset": { "name": "ReadPreset", "http": { "method": "GET", "uri": "/2012-09-25/presets/{Id}" }, "input": { "shape_name": "ReadPresetRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the preset for which you want to get detailed information.

\n ", "location": "uri" } }, "documentation": "\n

The ReadPresetRequest structure.

\n " }, "output": { "shape_name": "ReadPresetResponse", "type": "structure", "members": { "Preset": { "shape_name": "Preset", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the preset.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the preset.

\n " }, "Description": { "shape_name": "Description", "type": "string", "min_length": 0, "max_length": 255, "documentation": "\n

A description of the preset.

\n " }, "Container": { "shape_name": "PresetContainer", "type": "string", "pattern": "(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^ogg$)", "documentation": "\n

The container type for the output file. Valid values include mp3,\n mp4, ogg, ts, and webm.

\n " }, "Audio": { "shape_name": "AudioParameters", "type": "structure", "members": { "Codec": { "shape_name": "AudioCodec", "type": "string", "pattern": "(^AAC$)|(^vorbis$)|(^mp3$)", "documentation": "\n

The audio codec for the output file. Valid values include aac, \n mp3, and vorbis.

\n " }, "SampleRate": { "shape_name": "AudioSampleRate", "type": "string", "pattern": "(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)", "documentation": "\n

The sample rate of the audio stream in the output file, in Hertz. Valid values\n include:

\n

auto, 22050, 32000, 44100,\n 48000, 96000

\n

If you specify auto, Elastic Transcoder automatically detects the sample rate.

\n " }, "BitRate": { "shape_name": "AudioBitRate", "type": "string", "pattern": "^\\d{1,3}$", "documentation": "\n

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer\n between 64 and 320, inclusive.

\n " }, "Channels": { "shape_name": "AudioChannels", "type": "string", "pattern": "(^auto$)|(^0$)|(^1$)|(^2$)", "documentation": "\n

The number of audio channels in the output file. Valid values include:

\n

auto, 0, 1, 2

\n

If you specify auto, Elastic Transcoder automatically detects the number of channels in\n the input file.

\n " }, "CodecOptions": { "shape_name": "AudioCodecOptions", "type": "structure", "members": { "Profile": { "shape_name": "AudioCodecProfile", "type": "string", "pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)", "documentation": "\n

If you specified AAC for Audio:Codec, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:

\n \n

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.

 \n " } }, "documentation": "\n

If you specified AAC for Audio:Codec, this is the AAC \n compression profile to use. Valid values include:

\n

auto, AAC-LC, HE-AAC, HE-AACv2

\n

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

\n " } }, "documentation": "\n

A section of the response body that provides information about the audio preset\n values.

\n " }, "Video": { "shape_name": "VideoParameters", "type": "structure", "members": { "Codec": { "shape_name": "VideoCodec", "type": "string", "pattern": "(^H\\.264$)|(^vp8$)", "documentation": "\n

The video codec for the output file. Valid values include H.264 and\n vp8. You can only specify vp8 when the container type is\n webm.

\n " }, "CodecOptions": { "shape_name": "CodecOptions", "type": "map", "keys": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "members": { "shape_name": "CodecOption", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "max_length": 30, "documentation": "\n

\n Profile\n

\n

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following\n profiles:

\n \n

\n Level (H.264 Only)\n

\n

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following\n levels:

\n

1, 1b, 1.1, 1.2, 1.3,\n 2, 2.1, 2.2, 3,\n 3.1, 3.2, 4, 4.1

\n

\n MaxReferenceFrames (H.264 Only)\n

\n

Applicable only when the value of Video:Codec is H.264. The maximum number of previously\n decoded frames to use as a reference for decoding future frames. Valid values are\n integers 0 through 16, but we recommend that you not use a value greater than the\n following:

\n

\n Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels *\n Height in pixels)), 16)\n

\n

where Width in pixels and Height in pixels represent either MaxWidth and\n MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends\n on the value of the Level object. See the list below. (A macroblock is a\n block of pixels measuring 16x16.)

\n \n

\n MaxBitRate\n

\n

The maximum number of bits per second in a video buffer; the size of the buffer is\n specified by BufferSize. Specify a value between 16 and 62,500. You can\n reduce the bandwidth required to stream a video by reducing the maximum bit rate, but\n this also reduces the quality of the video.

\n

\n BufferSize\n

\n

The maximum number of bits in any x seconds of the output video. This window is commonly\n 10 seconds, the standard segment duration when you're using MPEG-TS for the container\n type of the output video. Specify an integer greater than 0. If you specify\n MaxBitRate and omit BufferSize, Elastic Transcoder sets\n BufferSize to 10 times the value of MaxBitRate.

\n " }, "KeyframesMaxDist": { "shape_name": "KeyframesMaxDist", "type": "string", "pattern": "^\\d{1,6}$", "documentation": "\n

The maximum number of frames between key frames. Key frames are fully encoded frames; the\n frames between key frames are encoded based, in part, on the content of the key frames.\n The value is an integer formatted as a string; valid values are between 1 (every frame\n is a key frame) and 100000, inclusive. A higher value results in higher compression but\n may also discernibly decrease video quality.

\n " }, "FixedGOP": { "shape_name": "FixedGOP", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

Whether to use a fixed value for FixedGOP. Valid values are\n true and false:

\n \n " }, "BitRate": { "shape_name": "VideoBitRate", "type": "string", "pattern": "(^\\d{2,5}$)|(^auto$)", "documentation": "\n

The bit rate of the video stream in the output file, in kilobits/second. Valid values\n depend on the values of Level and Profile. If you specify\n auto, Elastic Transcoder uses the detected bit rate of the input source. If you\n specify a value other than auto, we recommend that you specify a value less\n than or equal to the maximum H.264-compliant value listed for your level and\n profile:

\n

\n Level - Maximum video bit rate in kilobits/second (baseline and main Profile) :\n maximum video bit rate in kilobits/second (high Profile)\n

\n \n " }, "FrameRate": { "shape_name": "FrameRate", "type": "string", "pattern": "(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

The frames per second for the video stream in the output file. Valid values include:

\n

auto, 10, 15, 23.97, 24,\n 25, 29.97, 30, 60

\n

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source.\n If you specify a frame rate, we recommend that you perform the following\n calculation:

\n

\n Frame rate = maximum recommended decoding speed in luma samples/second / (width in\n pixels * height in pixels)\n

\n

where:

\n \n

The maximum recommended decoding speed in Luma samples/second for each level is described\n in the following list (Level - Decoding speed):

\n \n " }, "MaxFrameRate": { "shape_name": "MaxFrameRate", "type": "string", "pattern": "(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)", "documentation": "\n

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of\n the input video for the frame rate of the output video. Specify the maximum frame rate\n that you want Elastic Transcoder to use when the frame rate of the input video is greater than the\n desired maximum frame rate of the output video. Valid values include: 10,\n 15, 23.97, 24, 25,\n 29.97, 30, 60.

\n " }, "Resolution": { "shape_name": "Resolution", "type": "string", "pattern": "(^auto$)|(^\\d{1,5}x\\d{1,5}$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The width and height of the video in the output file, in pixels. Valid values are\n auto and width x height:

\n \n

Note the following about specifying the width and height:

\n \n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of output videos, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, PaddingPolicy, and\n DisplayAspectRatio instead of Resolution and\n AspectRatio. The two groups of settings are mutually exclusive. Do\n not use them together.

\n \n

The display aspect ratio of the video in the output file. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input\n file.

\n

If you specify an aspect ratio for the output file that differs from aspect ratio of the\n input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars\n on the top and bottom) to maintain the aspect ratio of the active region of the\n video.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 128 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder\n uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 96 and 3072.

\n " }, "DisplayAspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n

The value that Elastic Transcoder adds to the metadata in the output file.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of the output video:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to\n the top and bottom and/or left and right sides of the output video to make the total\n size of the output video match the values that you specified for MaxWidth\n and MaxHeight.

\n " }, "Watermarks": { "shape_name": "PresetWatermarks", "type": "list", "members": { "shape_name": "PresetWatermark", "type": "structure", "members": { "Id": { "shape_name": "PresetWatermarkId", "type": "string", "min_length": 1, "max_length": 40, "documentation": " A unique identifier for the settings for one\n watermark. The value of Id can be up to 40 characters long. " }, "MaxWidth": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum width of the watermark in one of the following formats:

\n " }, "MaxHeight": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The maximum height of the watermark in one of the following formats:

If you specify the value in pixels, it must be less than or equal to the value of\n MaxHeight.

\n " }, "SizingPolicy": { "shape_name": "WatermarkSizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Stretch$)|(^ShrinkToFit$)", "documentation": "\n

A value that controls scaling of the watermark:

\n

\n " }, "HorizontalAlign": { "shape_name": "HorizontalAlign", "type": "string", "pattern": "(^Left$)|(^Right$)|(^Center$)", "documentation": "\n

The horizontal position of the watermark unless you specify a non-zero value for\n HorizontalOffset:

\n " }, "HorizontalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n

The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign:

For example, if you specify Left for HorizontalAlign and 5px for\n HorizontalOffset, the left side of the watermark appears 5 pixels from\n the left border of the output video.

\n

HorizontalOffset is only valid when the value of\n HorizontalAlign is Left or Right. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.

\n

Use the value of Target to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.

\n " }, "VerticalAlign": { "shape_name": "VerticalAlign", "type": "string", "pattern": "(^Top$)|(^Bottom$)|(^Center$)", "documentation": "\n

The vertical position of the watermark unless you specify a non-zero value for\n VerticalOffset:

\n " }, "VerticalOffset": { "shape_name": "PixelsOrPercent", "type": "string", "pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)", "documentation": "\n VerticalOffset\n

The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:

For example, if you specify Top for VerticalAlign and\n 5px for VerticalOffset, the top of the watermark appears 5\n pixels from the top border of the output video.

\n

VerticalOffset is only valid when the value of VerticalAlign is Top or\n Bottom.

\n

If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.

\n\n

Use the value of Target to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.

\n " }, "Opacity": { "shape_name": "Opacity", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{0,20})?$", "documentation": "\n

A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n Opacity is float.

\n

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n Opacity. The .jpg file format doesn't support transparency.

\n " }, "Target": { "shape_name": "Target", "type": "string", "pattern": "(^Content$)|(^Frame$)", "documentation": "\n

A value that determines how Elastic Transcoder interprets values that you specified for\n HorizontalOffset, VerticalOffset, MaxWidth,\n and MaxHeight:

\n " } }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " }, "documentation": "\n

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay\n over videos that are transcoded using this preset. You can specify settings for up to\n four watermarks. Watermarks appear in the specified size and location, and with the\n specified opacity for the duration of the transcoded video.

\n

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not\n rectangular, use the .png format, which supports transparency.

\n

When you create a job that uses this preset, you specify the .png or .jpg graphics that\n you want Elastic Transcoder to include in the transcoded videos. You can specify fewer\n graphics in the job than you specify watermark settings in the preset, which allows you\n to use the same preset for up to four watermarks that have different dimensions.

\n " } }, "documentation": "\n

A section of the response body that provides information about the video preset\n values.

\n " }, "Thumbnails": { "shape_name": "Thumbnails", "type": "structure", "members": { "Format": { "shape_name": "JpgOrPng", "type": "string", "pattern": "(^jpg$)|(^png$)", "documentation": "\n

The format of thumbnails, if any. Valid values are jpg and png.

\n

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

\n " }, "Interval": { "shape_name": "Digits", "type": "string", "pattern": "^\\d{1,5}$", "documentation": "\n

The number of seconds between thumbnails. Specify an integer value.

\n " }, "Resolution": { "shape_name": "ThumbnailResolution", "type": "string", "pattern": "^\\d{1,5}x\\d{1,5}$", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The width and height of thumbnail files in pixels. Specify a value in the format\n width x height where both values are\n even integers. The values cannot exceed the width and height that you specified in the\n Video:Resolution object.

\n " }, "AspectRatio": { "shape_name": "AspectRatio", "type": "string", "pattern": "(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)", "documentation": "\n \n

To better control resolution and aspect ratio of thumbnails, we recommend that you\n use the values MaxWidth, MaxHeight,\n SizingPolicy, and PaddingPolicy instead of\n Resolution and AspectRatio. The two groups of settings\n are mutually exclusive. Do not use them together.

\n \n

The aspect ratio of thumbnails. Valid values include:

\n

auto, 1:1, 4:3, 3:2,\n 16:9

\n

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in\n the output file.

\n " }, "MaxWidth": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1920 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 4096.

\n " }, "MaxHeight": { "shape_name": "DigitsOrAuto", "type": "string", "pattern": "(^auto$)|(^\\d{2,4}$)", "documentation": "\n

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses\n 1080 (Full HD) as the default value. If you specify a numeric value, enter an even\n integer between 32 and 3072.

\n " }, "SizingPolicy": { "shape_name": "SizingPolicy", "type": "string", "pattern": "(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)", "documentation": "\n

Specify one of the following values to control scaling of thumbnails:

\n

\n

\n

\n " }, "PaddingPolicy": { "shape_name": "PaddingPolicy", "type": "string", "pattern": "(^Pad$)|(^NoPad$)", "documentation": "\n

When you set PaddingPolicy to Pad, Elastic Transcoder may add\n black bars to the top and bottom and/or left and right sides of thumbnails to make the\n total size of the thumbnails match the values that you specified for thumbnail\n MaxWidth and MaxHeight settings.

\n " } }, "documentation": "\n

A section of the response body that provides information about the thumbnail preset\n values, if any.

\n " }, "Type": { "shape_name": "PresetType", "type": "string", "pattern": "(^System$)|(^Custom$)", "documentation": "\n

Whether the preset is a default preset provided by Elastic Transcoder\n (System) or a preset that you have defined (Custom).

\n " } }, "documentation": "\n

A section of the response body that provides information about the preset.

\n " } }, "documentation": "\n

The ReadPresetResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The ReadPreset operation gets detailed information about a preset.

\n \n \n GET /2012-09-25/presets/5555555555555-abcde5 HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] \n Status: 200 OK Content-Type: charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256\n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature] { \"Preset\":{ \"Audio\":{\n \"Codec\":\"AAC\", \"SampleRate\":\"44100\", \"BitRate\":96, \"Channels\":2 },\n \"Container\":\"mp4\", \"Description\":\"Use for published videos\",\n \"Id\":\"5555555555555-abcde5\", \"Name\":\"DefaultPreset\", \"Thumbnails\":{ \"Format\":\"png\",\n \"Interval\":\"120\", \"MaxWidth\": \"auto\", \"MaxHeight\": \"auto\", \"SizingPolicy\":\n \"Fill\", \"PaddingPolicy\": \"Pad\" }, \"Type\":\"Custom\", \"Video\":{ \"MaxWidth\": \"auto\",\n \"MaxHeight\": \"auto\", \"SizingPolicy\": \"Fill\", \"PaddingPolicy\": \"Pad\",\n \"DisplayAspectRatio\": \"auto\", \"BitRate\":\"1600\", \"Codec\":\"H.264\",\n \"CodecOptions\":{ \"Level\":\"2.2\", \"MaxReferenceFrames\":\"3\", \"Profile\":\"main\",\n \"MaxBitRate\":\"\", \"BufferSize\":\"\" }, \"FixedGOP\":\"false\", \"FrameRate\":\"30\",\n \"KeyframesMaxDist\":\"240\" } } }\n \n \n " }, "TestRole": { "name": "TestRole", "http": { "method": "POST", "uri": "/2012-09-25/roleTests", "response_code": 200 }, "input": { "shape_name": "TestRoleRequest", "type": "structure", "members": { "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to\n test.

\n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read\n from this bucket.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket that Elastic Transcoder will write transcoded media files to. The action attempts to\n read from this bucket.

\n " }, "Topics": { "shape_name": "SnsTopics", "type": "list", "members": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": null }, "max_length": 30, "documentation": "\n

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test\n notification to.

\n " } }, "documentation": "\n

The TestRoleRequest structure.

\n " }, "output": { "shape_name": "TestRoleResponse", "type": "structure", "members": { "Success": { "shape_name": "Success", "type": "string", "pattern": "(^true$)|(^false$)", "documentation": "\n

If the operation is successful, this value is true; otherwise, the value is\n false.

\n " }, "Messages": { "shape_name": "ExceptionMessages", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

If the Success element contains false, this value is an array\n of one or more error messages that were generated during the test process.

\n " } }, "documentation": "\n

The TestRoleResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The TestRole operation tests the IAM role used to create the pipeline.

\n

The TestRole action lets you determine whether the IAM role you are using\n has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding\n process. The action attempts to assume the specified IAM role, checks read access to the\n input and output buckets, and tries to send a test notification to Amazon SNS topics\n that you specify.

\n \n \n POST /2012-09-25/roleTests HTTP/1.1 Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] {\n \"InputBucket\":\"salesoffice.example.com-source\",\n \"OutputBucket\":\"salesoffice.example.com-public-promos\",\n \"Role\":\"arn:aws:iam::123456789012:role/transcode-service\", \"Topics\":\n [\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\",\n \"arn:aws:sns:us-east-1:111222333444:ETS_Progressing\"] }\n Status: 200 OK x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Messages\":[ \"The role\n arn:aws:iam::123456789012:role/transcode-service does not have access to the\n bucket: salesoffice.example.com-source\", \"The role\n arn:aws:iam::123456789012:role/transcode-service does not have access to the\n topic: arn:aws:sns:us-east-1:111222333444:ETS_Errors\" ], \"Success\": \"false\"\n }\n \n \n " }, "UpdatePipeline": { "name": "UpdatePipeline", "http": { "method": "PUT", "uri": "/2012-09-25/pipelines/{Id}", "response_code": 200 }, "input": { "shape_name": "UpdatePipelineRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The ID of the pipeline that you want to update.

\n ", "required": true, "location": "uri" }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you saved the media files that you want to transcode and\n the graphics that you want to use as watermarks.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

The optional ContentConfig object specifies information about the Amazon S3\n bucket in which you want Elastic Transcoder to save transcoded files and playlists:\n which bucket to use, which users you want to have access to the files, the type of\n access you want users to have, and the storage class that you want to assign to the\n files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

The ThumbnailConfig object specifies several values, including the Amazon S3\n bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have\n access to the files, the type of access you want users to have, and the storage class\n that you want to assign to the files.

\n

If you specify values for ContentConfig, you must also specify values for\n ThumbnailConfig even if you don't want to create thumbnails.

\n

If you specify values for ContentConfig and ThumbnailConfig,\n omit the OutputBucket object.

\n \n " } }, "documentation": "\n

The UpdatePipelineRequest structure.

\n " }, "output": { "shape_name": "UpdatePipelineResponse", "type": "structure", "members": { "Pipeline": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

The pipeline (queue) that is used to manage jobs.

\n ", "required": true } }, "documentation": "\n

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.\n

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\n

The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

Use the UpdatePipeline operation to update settings for a pipeline.\n When you change pipeline settings, your changes take effect immediately.\n Jobs that you have already submitted and that Elastic Transcoder has not started to process are\n affected in addition to jobs that you submit after you change settings. \n

\n " }, "UpdatePipelineNotifications": { "name": "UpdatePipelineNotifications", "http": { "method": "POST", "uri": "/2012-09-25/pipelines/{Id}/notifications" }, "input": { "shape_name": "UpdatePipelineNotificationsRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the pipeline for which you want to change notification settings.

\n ", "location": "uri" }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job\n status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " } }, "documentation": "\n

The UpdatePipelineNotificationsRequest structure.

\n " }, "output": { "shape_name": "UpdatePipelineNotificationsResponse", "type": "structure", "members": { "Pipeline": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

A section of the response body that provides information about the pipeline.

\n " } }, "documentation": "\n

The UpdatePipelineNotificationsResponse structure.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\n

The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS)\n notifications for a pipeline.

\n

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified\n in the request.

\n \n \n POST /2012-09-25/pipelines/1111111111111-abcde1/notifications HTTP/1.1\n Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Id\":\"1111111111111-abcde1\", \"Notifications\":{\n \"Progressing\":\"\", \"Completed\":\"\", \"Warning\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\" } }\n Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Id\":\"1111111111111-abcde1\",\n \"Notifications\":{ \"Completed\":\"\",\n \"Error\":\"arn:aws:sns:us-east-1:111222333444:ETS_Errors\", \"Progressing\":\"\",\n \"Warning\":\"\" } }\n \n \n " }, "UpdatePipelineStatus": { "name": "UpdatePipelineStatus", "http": { "method": "POST", "uri": "/2012-09-25/pipelines/{Id}/status" }, "input": { "shape_name": "UpdatePipelineStatusRequest", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier of the pipeline to update.

\n ", "location": "uri" }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The desired status of the pipeline:

\n \n " } }, "documentation": "\n

The UpdatePipelineStatusRequest structure.

\n " }, "output": { "shape_name": "UpdatePipelineStatusResponse", "type": "structure", "members": { "Pipeline": { "shape_name": "Pipeline", "type": "structure", "members": { "Id": { "shape_name": "Id", "type": "string", "pattern": "^\\d{13}-\\w{6}$", "documentation": "\n

The identifier for the pipeline. You use this value to identify the pipeline in which you\n want to perform a variety of operations, such as creating a job or a preset.

\n " }, "Arn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the pipeline.

\n " }, "Name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 40, "documentation": "\n

The name of the pipeline. We recommend that the name be unique within the AWS account,\n but uniqueness is not enforced.

\n

Constraints: Maximum 40 characters

\n " }, "Status": { "shape_name": "PipelineStatus", "type": "string", "pattern": "(^Active$)|(^Paused$)", "documentation": "\n

The current status of the pipeline:

\n \n " }, "InputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the\n graphics files, if any, that you want to use for watermarks.

\n " }, "OutputBucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files,\n thumbnails, and playlists. Either you specify this value, or you specify both\n ContentConfig and ThumbnailConfig.

\n " }, "Role": { "shape_name": "Role", "type": "string", "pattern": "^arn:aws:iam::\\w{12}:role/.+$", "documentation": "\n

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode\n jobs for this pipeline.

\n " }, "Notifications": { "shape_name": "Notifications", "type": "structure", "members": { "Progressing": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the\n job.

\n " }, "Completed": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

\n " }, "Warning": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

\n " }, "Error": { "shape_name": "SnsTopic", "type": "string", "pattern": "(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)", "documentation": "\n

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

\n " } }, "documentation": "\n

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

\n To receive notifications, you must also subscribe to the new topic in the Amazon SNS\n console.\n \n " }, "ContentConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n transcoded files and playlists. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " }, "ThumbnailConfig": { "shape_name": "PipelineOutputConfig", "type": "structure", "members": { "Bucket": { "shape_name": "BucketName", "type": "string", "pattern": "^(\\w|\\.|-){1,255}$", "documentation": "\n

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this\n value when all of the following are true:

If you want to save transcoded files and playlists in one bucket and thumbnails in\n another bucket, specify which users can access the transcoded files or the permissions\n the users have, or change the Amazon S3 storage class, omit OutputBucket and specify\n values for ContentConfig and ThumbnailConfig instead.

\n " }, "StorageClass": { "shape_name": "StorageClass", "type": "string", "pattern": "(^ReducedRedundancy$)|(^Standard$)", "documentation": "\n

The Amazon S3 storage class, Standard or ReducedRedundancy,\n that you want Elastic Transcoder to assign to the video files and playlists that it stores in your\n Amazon S3 bucket.

\n " }, "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "GranteeType": { "shape_name": "GranteeType", "type": "string", "pattern": "(^Canonical$)|(^Email$)|(^Group$)", "documentation": "\n

The type of value that appears in the Grantee object:

\n

\n " }, "Grantee": { "shape_name": "Grantee", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

The AWS user or group that you want to have access to transcoded files and playlists. To\n identify the user or group, you can specify the canonical user ID for an AWS account, an\n origin access identity for a CloudFront distribution, the registered email address of an\n AWS account, or a predefined Amazon S3 group.

\n " }, "Access": { "shape_name": "AccessControls", "type": "list", "members": { "shape_name": "AccessControl", "type": "string", "pattern": "(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)", "documentation": null }, "max_length": 30, "documentation": "\n

The permission that you want to give to the AWS user that is listed in Grantee. Valid\n values include:

\n

\n " } }, "documentation": "\n

The Permission structure.

\n " }, "max_length": 30, "documentation": "\n

Optional. The Permissions object specifies which users and/or predefined\n Amazon S3 groups you want to have access to transcoded files and playlists, and the type\n of access you want them to have. You can grant permissions to a maximum of 30 users\n and/or predefined Amazon S3 groups.

\n

If you include Permissions, Elastic Transcoder grants only the permissions that you\n specify. It does not grant full permissions to the owner of the role specified by\n Role. If you want that user to have full control, you must explicitly\n grant full control to the user.

\n

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files\n and playlists to the owner of the role specified by Role, and grants no\n other permissions to any other user or group.

\n " } }, "documentation": "\n

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save\n thumbnail files. Either you specify both ContentConfig and\n ThumbnailConfig, or you specify OutputBucket.

\n \n " } }, "documentation": "\n

A section of the response body that provides information about the pipeline.

\n " } }, "documentation": "When you update status for a pipeline,\n Elastic Transcoder returns the values that you specified in the request." }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": {}, "documentation": "\n

One or more required parameter values were not provided in the request.

\n " }, { "shape_name": "IncompatibleVersionException", "type": "structure", "members": {}, "documentation": null }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The requested resource does not exist or is not available. For example, the pipeline to\n which you're trying to add a job doesn't exist or is still being created.

\n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": {}, "documentation": "\n

The resource you are attempting to change is in use. For example, you are attempting to\n delete a pipeline that is currently in use.

\n " }, { "shape_name": "AccessDeniedException", "type": "structure", "members": {}, "documentation": "\n

General authentication failure. The request was not signed correctly.

\n " }, { "shape_name": "InternalServiceException", "type": "structure", "members": {}, "documentation": "\n

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

\n " } ], "documentation": "\n

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline\n stops or restarts the processing of jobs.

\n

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't\n cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which\n you submitted the jobs, you have more time to get the job IDs for the jobs that you want\n to cancel, and to send a CancelJob request.

\n \n \n POST /2012-09-25/pipelines/1111111111111-abcde1/status HTTP/1.1\n Content-Type: application/json; charset=UTF-8\nAccept: */*\nHost: elastictranscoder.[Elastic Transcoder-endpoint].amazonaws.com:443\nx-amz-date: 20130114T174952Z\nAuthorization: AWS4-HMAC-SHA256 \n Credential=[access-key-id]/[request-date]/[Elastic Transcoder-endpoint]/ets/aws4_request,\n SignedHeaders=host;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nContent-Length: [number-of-characters-in-JSON-string] { \"Id\":\"1111111111111-abcde1\", \"Status\":\"Active\" } \n Status: 202 Accepted x-amzn-RequestId: c321ec43-378e-11e2-8e4c-4d5b971203e9\nContent-Type: application/json\nContent-Length: [number-of-characters-in-response]\nDate: Mon, 14 Jan 2013 06:01:47 GMT { \"Id\":\"1111111111111-abcde1\",\n \"Status\":\"Active\" } \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null }, "protocols": [ "https" ] }, "pagination": { "ListJobsByPipeline": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs", "py_input_token": "page_token" }, "ListJobsByStatus": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs", "py_input_token": "page_token" }, "ListPipelines": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Pipelines", "py_input_token": "page_token" }, "ListPresets": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Presets", "py_input_token": "page_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/elb.json0000644000175000017500000055014612254746566017720 0ustar takakitakaki{ "api_version": "2012-06-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Elastic Load Balancing", "endpoint_prefix": "elasticloadbalancing", "documentation": "\n \tElastic Load Balancing\n \n

\n Elastic Load Balancing is a cost-effective and easy\n to use web service to help you improve the availability and\n scalability of your application running on Amazon Elastic Cloud Compute (Amazon EC2). It makes it easy for\n you to distribute application loads between two or more\n EC2 instances. Elastic Load Balancing supports the growth in traffic of your application by enabling availability through redundancy.\n

\n \n

This guide provides detailed information about Elastic Load Balancing \n actions, data types, and parameters that can be used for sending a \n query request. Query requests are HTTP or HTTPS requests that use the \n HTTP verb GET or POST and a query parameter named Action or Operation. \n Action is used throughout this documentation, although Operation is \n supported for backward compatibility with other AWS Query APIs.

\n \n

For detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide,\n go to Using the Query API\n in the Elastic Load Balancing Developer Guide.

\n \n

For detailed information about Elastic Load Balancing features and their associated actions, go to \n Using Elastic Load Balancing\n in the Elastic Load Balancing Developer Guide.

\n \n

This reference guide is based on the current WSDL, which is available at:\n \n

\n

Endpoints

\n

The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.

\n

You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see \n Regions and Endpoints \n in the Amazon Web Services General Reference.\n

\n \n ", "operations": { "ApplySecurityGroupsToLoadBalancer": { "name": "ApplySecurityGroupsToLoadBalancer", "input": { "shape_name": "ApplySecurityGroupsToLoadBalancerInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account. \n

\n ", "required": true }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "SecurityGroupId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of security group IDs to associate with your load balancer in VPC. The security\n group IDs must be provided as the ID and not the security group name (For example, sg-1234).\n

\n ", "required": true } }, "documentation": "\n

\n The input for the ApplySecurityGroupsToLoadBalancer action.\n

\n " }, "output": { "shape_name": "ApplySecurityGroupsToLoadBalancerOutput", "type": "structure", "members": { "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "SecurityGroupId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of security group IDs associated with your load balancer.\n

\n " } }, "documentation": "\n

\n The out for the ApplySecurityGroupsToLoadBalancer action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " }, { "shape_name": "InvalidSecurityGroupException", "type": "structure", "members": {}, "documentation": "\n

\n One or more specified security groups do not exist. \n

\n " } ], "documentation": "\n

\n Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). \n The provided security group IDs will override any currently applied security groups.\n

\n

For more information, see Manage Security Groups in Amazon VPC in the Elastic Load Balancing Developer Guide.

\n \n \n https://elasticloadbalancing.amazonaws.com/?SecurityGroups.member.1=sg-123456789\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=ApplySecurityGroupsToLoadBalancer\n&AUTHPARAMS \n \n \n \n sg-123456789\n \n \n \n 06b5decc-102a-11e3-9ad6-bf3e4EXAMPLE\n \n\n \n \n " }, "AttachLoadBalancerToSubnets": { "name": "AttachLoadBalancerToSubnets", "input": { "shape_name": "AttachLoadBalancerToSubnetsInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account.\n

\n ", "required": true }, "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone.\n

\n ", "required": true } }, "documentation": "\n

\n The input for the AttachLoadBalancerToSubnets action. \n

\n " }, "output": { "shape_name": "AttachLoadBalancerToSubnetsOutput", "type": "structure", "members": { "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of subnet IDs attached to the load balancer. \n

\n " } }, "documentation": "\n

\n The output for the AttachLoadBalancerToSubnets action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " }, { "shape_name": "SubnetNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more subnets were not found.\n

\n " }, { "shape_name": "InvalidSubnetException", "type": "structure", "members": {}, "documentation": "\n

\n The VPC has no Internet gateway. \n

\n " } ], "documentation": "\n

\n Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.\n

\n

\n The load balancers evenly distribute requests across all of the registered subnets. \n For more information, see Deploy Elastic Load Balancing in Amazon VPC in the Elastic Load Balancing Developer Guide.\n

\n \n https://elasticloadbalancing.amazonaws.com/?Subnets.member.1=subnet-3561b05e\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=AttachLoadBalancerToSubnets\n&AUTHPARAMS \n \n\n \n subnet-119f0078\n subnet-3561b05e\n \n\n \n 07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE\n \n\n \n \n " }, "ConfigureHealthCheck": { "name": "ConfigureHealthCheck", "input": { "shape_name": "ConfigureHealthCheckInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The mnemonic name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account.\n

\n ", "required": true }, "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Target": { "shape_name": "HealthCheckTarget", "type": "string", "documentation": "\n

\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n

\n \n

\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n

\n

SSL is also specified as SSL: port pair, for example, SSL:5000.

\n

\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n

\n

\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n

\n \n ", "required": true }, "Interval": { "shape_name": "HealthCheckInterval", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n

\n ", "required": true }, "Timeout": { "shape_name": "HealthCheckTimeout", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n

\n \n This value must be less than the Interval value.\n \n ", "required": true }, "UnhealthyThreshold": { "shape_name": "UnhealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe failures required\n before moving the instance to the Unhealthy state.\n

\n ", "required": true }, "HealthyThreshold": { "shape_name": "HealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe successes required before\n moving the instance to the Healthy state.\n

\n ", "required": true } }, "documentation": "\n

\n A structure containing the configuration information\n for the new healthcheck.\n

\n ", "required": true } }, "documentation": "\n

\n Input for the ConfigureHealthCheck action.\n

\n " }, "output": { "shape_name": "ConfigureHealthCheckOutput", "type": "structure", "members": { "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Target": { "shape_name": "HealthCheckTarget", "type": "string", "documentation": "\n

\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n

\n \n

\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n

\n

SSL is also specified as SSL: port pair, for example, SSL:5000.

\n

\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n

\n

\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n

\n \n ", "required": true }, "Interval": { "shape_name": "HealthCheckInterval", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n

\n ", "required": true }, "Timeout": { "shape_name": "HealthCheckTimeout", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n

\n \n This value must be less than the Interval value.\n \n ", "required": true }, "UnhealthyThreshold": { "shape_name": "UnhealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe failures required\n before moving the instance to the Unhealthy state.\n

\n ", "required": true }, "HealthyThreshold": { "shape_name": "HealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe successes required before\n moving the instance to the Healthy state.\n

\n ", "required": true } }, "documentation": "\n

\n The updated healthcheck for the instances.\n

\n " } }, "documentation": "\n

\n The output for the ConfigureHealthCheck action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " } ], "documentation": "\n

\n Specifies the health check settings to use for evaluating the health state of your back-end instances. \n

\n

For more information, see Health Check in the Elastic Load Balancing Developer Guide.

\n \n https://elasticloadbalancing.amazonaws.com/?HealthCheck.HealthyThreshold=2\n&HealthCheck.UnhealthyThreshold=2\n&LoadBalancerName=MyLoadBalancer\n&HealthCheck.Target=HTTP:80/ping\n&HealthCheck.Interval=30\n&HealthCheck.Timeout=3\n&Version=2012-06-01\n&Action=ConfigureHealthCheck\n&AUTHPARAMS \n \n\n \n 30\n HTTP:80/ping\n 2\n 3\n 2\n \n\n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n " }, "CreateAppCookieStickinessPolicy": { "name": "CreateAppCookieStickinessPolicy", "input": { "shape_name": "CreateAppCookieStickinessPolicyInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name of the load balancer. \n

\n ", "required": true }, "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

\n The name of the policy being created. \n The name must be unique within the set of policies for this load balancer. \n

\n ", "required": true }, "CookieName": { "shape_name": "CookieName", "type": "string", "documentation": "\n

\n Name of the application cookie used for stickiness. \n

\n ", "required": true } }, "documentation": "\n

\n The input for the CreateAppCookieStickinessPolicy action.\n

\n " }, "output": { "shape_name": "CreateAppCookieStickinessPolicyOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the CreateAppCookieStickinessPolicy action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "DuplicatePolicyNameException", "type": "structure", "members": {}, "documentation": "\n

\n Policy with the same name exists for this load balancer.\n Please choose another name.\n

\n " }, { "shape_name": "TooManyPoliciesException", "type": "structure", "members": {}, "documentation": "\n

\n Quota for number of policies for this load balancer\n has already been reached.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Generates a stickiness policy with sticky session lifetimes that follow \n that of an application-generated cookie. This policy can be associated\n only with HTTP/HTTPS listeners.\n

\n

\n This policy is similar to the policy created by CreateLBCookieStickinessPolicy, \n except that the lifetime of the special Elastic Load Balancing cookie follows the\n lifetime of the application-generated cookie specified in the policy configuration. \n The load balancer only inserts a new stickiness cookie when the application response\n includes a new application cookie. \n

\n

\n If the application cookie is explicitly removed or expires, the session stops being\n sticky until a new application cookie is issued. \n

\n \n An application client must receive and send two cookies: the application-generated \n cookie and the special Elastic Load Balancing cookie named AWSELB. \n This is the default behavior for many common web browsers.\n \n

For more information, see Enabling Application-Controlled Session Stickiness\n in the Elastic Load Balancing Developer Guide.

\n \n https://elasticloadbalancing.amazonaws.com/?CookieName=MyAppCookie\n&LoadBalancerName=MyLoadBalancer\n&PolicyName=MyAppStickyPolicy\n&Version=2012-06-01\n&Action=CreateAppCookieStickinessPolicy\n&AUTHPARAMS \n \n\n\n 99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE\n\n\n \n \n " }, "CreateLBCookieStickinessPolicy": { "name": "CreateLBCookieStickinessPolicy", "input": { "shape_name": "CreateLBCookieStickinessPolicyInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer. \n

\n ", "required": true }, "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

\n The name of the policy being created. \n The name must be unique within the set of policies for this load balancer. \n

\n ", "required": true }, "CookieExpirationPeriod": { "shape_name": "CookieExpirationPeriod", "type": "long", "documentation": "\n

\n The time period in seconds after which the cookie should be considered stale. \n Not specifying this parameter indicates that the sticky session will last for the duration \n of the browser session. \n

\n " } }, "documentation": "\n

\n The input for the CreateLBCookieStickinessPolicy action.\n

\n " }, "output": { "shape_name": "CreateLBCookieStickinessPolicyOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the CreateLBCookieStickinessPolicy action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "DuplicatePolicyNameException", "type": "structure", "members": {}, "documentation": "\n

\n Policy with the same name exists for this load balancer.\n Please choose another name.\n

\n " }, { "shape_name": "TooManyPoliciesException", "type": "structure", "members": {}, "documentation": "\n

\n Quota for number of policies for this load balancer\n has already been reached.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Generates a stickiness policy with sticky session lifetimes controlled by the \n lifetime of the browser (user-agent) or a specified expiration period. This \n policy can be associated only with HTTP/HTTPS listeners.\n

\n

\n When a load balancer implements this policy, the load balancer uses a special\n cookie to track the backend server instance for each request. When the load balancer\n receives a request, it first checks to see if this cookie is present in the request. \n If so, the load balancer sends the request to the application server specified in the\n cookie. If not, the load balancer sends the request to a server that is chosen based on\n the existing load balancing algorithm.\n

\n

\n A cookie is inserted into the response for binding subsequent requests from the same user to\n that server. The validity of the cookie is based on the cookie expiration time, which is \n specified in the policy configuration. \n

\n \n

For more information, see Enabling Duration-Based Session Stickiness\n in the Elastic Load Balancing Developer Guide.

\n \n https://elasticloadbalancing.amazonaws.com/?CookieExpirationPeriod=60\n&LoadBalancerName=MyLoadBalancer&PolicyName=MyDurationStickyPolicy\n&Version=2012-06-01\n&Action=CreateLBCookieStickinessPolicy\n&AUTHPARAMS \n \n\n\n 99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE\n\n\n \n \n \n " }, "CreateLoadBalancer": { "name": "CreateLoadBalancer", "input": { "shape_name": "CreateAccessPointInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer.\n The name must be unique within your set of load balancers.\n

\n ", "required": true }, "Listeners": { "shape_name": "Listeners", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n

\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "LoadBalancerPort": { "shape_name": "AccessPointPort", "type": "integer", "documentation": "\n

\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "InstanceProtocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n \t

\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t

\n \t\n \tIf the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t\n \t\n \tIf there is another listener with the same InstancePort whose InstanceProtocol is secure,\n \ti.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP,\n the listener's InstanceProtocol must be either HTTP or TCP. \n \t\n " }, "InstancePort": { "shape_name": "InstancePort", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "SSLCertificateId": { "shape_name": "SSLCertificateId", "type": "string", "documentation": "\n

\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n UploadServerCertificate \t\n API.

\n " } }, "documentation": "\n

\n The Listener data type.\n

\n " }, "documentation": "\n

\n A list of the following tuples:\n LoadBalancerPort, InstancePort, and Protocol.\n

\n ", "required": true }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n A list of Availability Zones.\n

\n

\n At least one Availability Zone must be specified.\n Specified Availability Zones must be in the same EC2 Region\n as the load balancer.\n Traffic will be equally distributed across all zones.\n

\n

\n You can later add more Availability Zones after the creation of the \n load balancer by calling EnableAvailabilityZonesForLoadBalancer action.\n

\n " }, "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of subnet IDs in your VPC to attach to your load balancer.\n Specify one subnet per Availability Zone.\n

\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "SecurityGroupId", "type": "string", "documentation": null }, "documentation": "\n

\n The security groups to assign to your load balancer within your VPC.\n

\n " }, "Scheme": { "shape_name": "LoadBalancerScheme", "type": "string", "documentation": "\n

The type of a load balancer.

\n \n

By default, Elastic Load Balancing creates an Internet-facing load balancer\n with a publicly resolvable DNS name, which resolves to public IP addresses.\n For more informationabout Internet-facing and Internal load balancers, \n see Internet-facing and Internal Load Balancers.

\n \n

Specify the value internal for this option to create an internal load balancer\n with a DNS name that resolves to private IP addresses.

\n \n

This option is only available for load balancers created within EC2-VPC.

\n \n \n " } }, "documentation": "\n

\n The input for the CreateLoadBalancer action.\n

\n " }, "output": { "shape_name": "CreateAccessPointOutput", "type": "structure", "members": { "DNSName": { "shape_name": "DNSName", "type": "string", "documentation": "\n

\n The DNS name for the load balancer.\n

\n " } }, "documentation": "\n

\n The output for the CreateLoadBalancer action.\n

\n " }, "errors": [ { "shape_name": "DuplicateAccessPointNameException", "type": "structure", "members": {}, "documentation": "\n

\n Load balancer name already exists for this account.\n Please choose another name.\n

\n " }, { "shape_name": "TooManyAccessPointsException", "type": "structure", "members": {}, "documentation": "\n

\n The quota for the number of load balancers has already been reached.\n

\n " }, { "shape_name": "CertificateNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " }, { "shape_name": "SubnetNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more subnets were not found.\n

\n " }, { "shape_name": "InvalidSubnetException", "type": "structure", "members": {}, "documentation": "\n

\n The VPC has no Internet gateway. \n

\n " }, { "shape_name": "InvalidSecurityGroupException", "type": "structure", "members": {}, "documentation": "\n

\n One or more specified security groups do not exist. \n

\n " }, { "shape_name": "InvalidSchemeException", "type": "structure", "members": {}, "documentation": "\n

\n Invalid value for scheme. Scheme can only be specified for load balancers in VPC. \n

\n " } ], "documentation": "\n

\n Creates a new load balancer.\n

\n

\n After the call has completed successfully, a new load balancer\n is created with a unique Domain Name Service (DNS) name. The DNS \n name includes the name of the AWS region in which the load balance \n was created. For example, if your load balancer was created in the\n United States, the DNS name might end with either of the following:

\n \n

For information about the AWS regions supported by Elastic Load Balancing, \n see Regions and Endpoints.

\n \n

You can create up to 10 load balancers per region per account.

\n \n

Elastic Load Balancing supports load balancing your Amazon EC2 instances launched\n within any one of the following platforms:

\n \n \n \n \n Create a TCP load balancer in EC2-Classic \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyLoadBalancer\n&AvailabilityZones.member.1=us-east-1c\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS \n \n\n MyLoadBalancer-1234567890.us-east-1.elb.amazonaws.com\n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n Create HTTPS load balancer in EC2-Classic \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyHTTPSLoadBalancer\n&AvailabilityZones.member.1=us-east-1c\n&Listeners.member.1.LoadBalancerPort=443\n&Listeners.member.1.InstancePort=443\n&Listeners.member.1.Protocol=https\n&Listeners.member.1.InstanceProtocol=https\n&Listeners.member.1.SSLCertificateId=arn:aws:iam::123456789012:server-certificate/servercert\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS \n \n\n MyHTTPSLoadBalancer-1234567890.us-east-1.elb.amazonaws.com\n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n Create a TCP load balancer in EC2-VPC \n https://elasticloadbalancing.amazonaws.com/?SecurityGroups.member.1=sg-6801da07\n&LoadBalancerName=MyVPCLoadBalancer\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Subnets.member.1=subnet-6dec9f03\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS \n \n\n MyVPCLoadBalancer-1234567890.us-east-1.elb.amazonaws.com\n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n Create an internal TCP load balancer in EC2-VPC \n https://elasticloadbalancing.amazonaws.com/?Scheme=internal\n&SecurityGroups.member.1=sg-706cb61f\n&LoadBalancerName=MyInternalLoadBalancer\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Subnets.member.1=subnet-9edc97f0\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS \n \n\n internal-MyInternalLoadBalancer-1234567890.us-east-1.elb.amazonaws.com\n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n Create a TCP load balancer in default VPC \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyDefaultVPCLoadBalancer\n&AvailabilityZones.member.1=sa-east-1b\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS \n \n\n MyDefaultVPCLoadBalancer-1234567890.sa.east-1.elb.amazonaws.com\n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n " }, "CreateLoadBalancerListeners": { "name": "CreateLoadBalancerListeners", "input": { "shape_name": "CreateLoadBalancerListenerInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name of the load balancer. \n

\n ", "required": true }, "Listeners": { "shape_name": "Listeners", "type": "list", "members": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n

\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "LoadBalancerPort": { "shape_name": "AccessPointPort", "type": "integer", "documentation": "\n

\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "InstanceProtocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n \t

\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t

\n \t\n \tIf the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t\n \t\n \tIf there is another listener with the same InstancePort whose InstanceProtocol is secure,\n \ti.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP,\n the listener's InstanceProtocol must be either HTTP or TCP. \n \t\n " }, "InstancePort": { "shape_name": "InstancePort", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "SSLCertificateId": { "shape_name": "SSLCertificateId", "type": "string", "documentation": "\n

\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n UploadServerCertificate \t\n API.

\n " } }, "documentation": "\n

\n The Listener data type.\n

\n " }, "documentation": "\n

\n A list of LoadBalancerPort, \n InstancePort, \n Protocol, and \n SSLCertificateId items. \t\n

\n ", "required": true } }, "documentation": "\n

\n The input for the CreateLoadBalancerListeners action.\n

\n \n " }, "output": { "shape_name": "CreateLoadBalancerListenerOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the CreateLoadBalancerListeners action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "DuplicateListenerException", "type": "structure", "members": {}, "documentation": "\n

\n A Listener already exists for the given \n LoadBalancerName and LoadBalancerPort, \n but with a different InstancePort, Protocol, \n or SSLCertificateId. \t\n

\n " }, { "shape_name": "CertificateNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Creates one or more listeners on a load balancer for the specified port. \n If a listener with the given port does not already exist, it will be created; \n otherwise, the properties of the new listener must match the properties \n of the existing listener. \n

\n

For more information, see Add a Listener to Your Load Balancer \n in the Elastic Load Balancing Developer Guide.

\n \n \n Create HTTPS load balancer listener in EC2-Classic \n https://elasticloadbalancing.amazonaws.com/?Listeners.member.1.Protocol=https\n&Listeners.member.1.LoadBalancerPort=443\n&Listeners.member.1.InstancePort=443\n&Listeners.member.1.InstanceProtocol=https\n&Listeners.member.1.SSLCertificateId=arn:aws:iam::123456789012:server-certificate/servercert\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=CreateLoadBalancerListeners\n&AUTHPARAMS \n \n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n " }, "CreateLoadBalancerPolicy": { "name": "CreateLoadBalancerPolicy", "input": { "shape_name": "CreateLoadBalancerPolicyInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n \t

\n \tThe name associated with the LoadBalancer for which the policy is being created. \t\n \t

\n ", "required": true }, "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n \t

\n \tThe name of the load balancer policy being created.\n \tThe name must be unique within the set of policies for this load balancer.\n \t

\n ", "required": true }, "PolicyTypeName": { "shape_name": "PolicyTypeName", "type": "string", "documentation": "\n \t

\n \tThe name of the base policy type being used to create this policy.\n \tTo get the list of policy types, use the DescribeLoadBalancerPolicyTypes action.\n \t

\n ", "required": true }, "PolicyAttributes": { "shape_name": "PolicyAttributes", "type": "list", "members": { "shape_name": "PolicyAttribute", "type": "structure", "members": { "AttributeName": { "shape_name": "AttributeName", "type": "string", "documentation": "\n

\n The name of the attribute associated with the policy.\n

\n " }, "AttributeValue": { "shape_name": "AttributeValue", "type": "string", "documentation": "\n

\n The value of the attribute associated with the policy.\n

\n " } }, "documentation": "\n

\n The PolicyAttribute data type. This data type contains a key/value pair that defines properties of\n a specific policy.\n

\n " }, "documentation": "\n \t

\n \tA list of attributes associated with the policy being created.\n \t

\n " } }, "documentation": "\n " }, "output": { "shape_name": "CreateLoadBalancerPolicyOutput", "type": "structure", "members": {}, "documentation": "\n

The output for the CreateLoadBalancerPolicy action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "PolicyTypeNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more of the specified policy types do not exist.\n

\n " }, { "shape_name": "DuplicatePolicyNameException", "type": "structure", "members": {}, "documentation": "\n

\n Policy with the same name exists for this load balancer.\n Please choose another name.\n

\n " }, { "shape_name": "TooManyPoliciesException", "type": "structure", "members": {}, "documentation": "\n

\n Quota for number of policies for this load balancer\n has already been reached.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n \t

\n \tCreates a new policy that contains the necessary attributes depending on the policy type.\n \tPolicies are settings that are saved for your load balancer and that can be applied to the\n \tfront-end listener, or the back-end application server, depending on your policy type.\n \t

\n \n https://elasticloadbalancing.amazonaws.com/?PolicyAttributes.member.1.AttributeName=ProxyProtocol\n&PolicyAttributes.member.1.AttributeValue=true\n&PolicyTypeName=ProxyProtocolPolicyType\n&LoadBalancerName=my-test-loadbalancer\n&PolicyName=EnableProxyProtocol\n&Version=2012-06-01\n&Action=CreateLoadBalancerPolicy\n&AUTHPARAMS \n \n\n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n " }, "DeleteLoadBalancer": { "name": "DeleteLoadBalancer", "input": { "shape_name": "DeleteAccessPointInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer. \n

\n ", "required": true } }, "documentation": "\n

\n The input for the DeleteLoadBalancer action.\n

\n " }, "output": { "shape_name": "DeleteAccessPointOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the DeleteLoadBalancer action.\n

\n " }, "errors": [], "documentation": "\n

\n Deletes the specified load balancer.\n

\n

\n If attempting to recreate the load balancer,\n you must reconfigure all the settings.\n The DNS name associated with a deleted load balancer\n will no longer be usable.\n Once deleted, the name and associated DNS record of the\n load balancer no longer exist and traffic sent to any of its\n IP addresses will no longer be delivered to back-end instances. \n

\n

\n To successfully call this API, you must provide the same\n account credentials as were used to create the load balancer.\n

\n \n By design, if the load balancer does not exist or has already been deleted, a call to\n DeleteLoadBalancer action still succeeds.\n \n " }, "DeleteLoadBalancerListeners": { "name": "DeleteLoadBalancerListeners", "input": { "shape_name": "DeleteLoadBalancerListenerInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The mnemonic name associated with the load balancer. \n

\n ", "required": true }, "LoadBalancerPorts": { "shape_name": "Ports", "type": "list", "members": { "shape_name": "AccessPointPort", "type": "integer", "documentation": null }, "documentation": "\n

\n The client port number(s) of the load balancer listener(s) to be removed. \n

\n ", "required": true } }, "documentation": "\n

\n The input for the DeleteLoadBalancerListeners action.\n

\n " }, "output": { "shape_name": "DeleteLoadBalancerListenerOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the DeleteLoadBalancerListeners action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " } ], "documentation": "\n

\n Deletes listeners from the load balancer for the specified port.\n

\n \n " }, "DeleteLoadBalancerPolicy": { "name": "DeleteLoadBalancerPolicy", "input": { "shape_name": "DeleteLoadBalancerPolicyInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The mnemonic name associated with the load balancer. \n

\n ", "required": true }, "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

\n The mnemonic name for the policy being deleted. \n

\n ", "required": true } }, "documentation": "\n

\n The input for the DeleteLoadBalancerPolicy action.\n

\n " }, "output": { "shape_name": "DeleteLoadBalancerPolicyOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the DeleteLoadBalancerPolicy action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Deletes a policy from the load balancer. \n The specified policy must not be enabled for any listeners.\n

\n " }, "DeregisterInstancesFromLoadBalancer": { "name": "DeregisterInstancesFromLoadBalancer", "input": { "shape_name": "DeregisterEndPointsInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer. \n

\n ", "required": true }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n A list of EC2 instance IDs consisting of all\n instances to be deregistered.\n

\n ", "required": true } }, "documentation": "\n

\n The input for the DeregisterInstancesFromLoadBalancer action.\n

\n " }, "output": { "shape_name": "DeregisterEndPointsOutput", "type": "structure", "members": { "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n An updated list of remaining instances\n registered with the load balancer.\n

\n " } }, "documentation": "\n

\n The output for the DeregisterInstancesFromLoadBalancer action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidEndPointException", "type": "structure", "members": {}, "documentation": "\n

\n The specified EndPoint is not valid.\n

\n " } ], "documentation": "\n

\n Deregisters instances from the load balancer.\n Once the instance is deregistered,\n it will stop receiving traffic from the load balancer. \n

\n

\n In order to successfully call this API,\n the same account credentials as those\n used to create the load balancer must be provided.\n

\n

For more information, see De-register and Register Amazon EC2 Instances \n in the Elastic Load Balancing Developer Guide.

\n \n

You can use DescribeLoadBalancers to verify if the instance is deregistered from the load balancer.

\n \n \n Deregister instance i-e3677ad7 from MyHTTPSLoadBalancer load balancer. \n https://elasticloadbalancing.amazonaws.com/?Instances.member.1.InstanceId=i-e3677ad7\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=DeregisterInstancesFromLoadBalancer\n&AUTHPARAMS \n \n \n \n \n i-6ec63d59\n \n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n " }, "DescribeInstanceHealth": { "name": "DescribeInstanceHealth", "input": { "shape_name": "DescribeEndPointStateInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name of the load balancer. \n

\n ", "required": true }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n A list of instance IDs whose states are being queried.\n

\n " } }, "documentation": "\n

\n The input for the DescribeEndPointState action.\n

\n " }, "output": { "shape_name": "DescribeEndPointStateOutput", "type": "structure", "members": { "InstanceStates": { "shape_name": "InstanceStates", "type": "list", "members": { "shape_name": "InstanceState", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " }, "State": { "shape_name": "State", "type": "string", "documentation": "\n

Specifies the current state of the instance.

\n \n

Valid value: InService|OutOfService

\n " }, "ReasonCode": { "shape_name": "ReasonCode", "type": "string", "documentation": "\n

\n Provides information about the cause of OutOfService instances.\n Specifically, it indicates whether the cause is Elastic Load Balancing\n or the instance behind the load balancer.\n

\n

Valid value: ELB|Instance|N/A

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

\n Provides a description of the instance state.\n

\n " } }, "documentation": "\n

\n The InstanceState data type.\n

\n " }, "documentation": "\n

\n A list containing health information\n for the specified instances.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe output for the DescribeInstanceHealth action.\n\t\t

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidEndPointException", "type": "structure", "members": {}, "documentation": "\n

\n The specified EndPoint is not valid.\n

\n " } ], "documentation": "\n

\n Returns the current state of the specified instances registered with the specified load balancer.\n If no instances are specified, the state of all the instances registered with the load balancer is returned.\n

\n \n You must provide the same account credentials\n as those that were used to create the load balancer.\n \n \n \n Description of a healthy (InService) instance \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyLoadBalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS \n \n \n \n \n N/A\n i-90d8c2a5\n InService\n N/A\n \n \n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n \n \n \n \n Description of an instance with registration in progress \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS \n \n \n \n \n Instance registration is still in progress.\n i-315b7e51\n OutOfService\n ELB\n \n \n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n \n \n \n \n Description of an unhealthy (OutOfService) instance \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyLoadBalancer-2\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS \n \n \n \n \n Instance has failed at least the UnhealthyThreshold number of health checks consecutively.\n i-fda142c9\n OutOfService\n Instance\n \n \n \n \n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n " }, "DescribeLoadBalancerAttributes": { "name": "DescribeLoadBalancerAttributes", "input": { "shape_name": "DescribeLoadBalancerAttributesInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

The name of the load balancer.

\n ", "required": true } }, "documentation": "\n

The input for the DescribeLoadBalancerAttributes action.

\n " }, "output": { "shape_name": "DescribeLoadBalancerAttributesOutput", "type": "structure", "members": { "LoadBalancerAttributes": { "shape_name": "LoadBalancerAttributes", "type": "structure", "members": { "CrossZoneLoadBalancing": { "shape_name": "CrossZoneLoadBalancing", "type": "structure", "members": { "Enabled": { "shape_name": "CrossZoneLoadBalancingEnabled", "type": "boolean", "documentation": "\n

Specifies whether cross-zone load balancing is enabled for the load balancer.

\n ", "required": true } }, "documentation": "\n

The name of the load balancer attribute.

\n " } }, "documentation": "\n

The load balancer attributes structure.

\n " } }, "documentation": "\n

The following element is returned in a structure named DescribeLoadBalancerAttributesResult.

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "LoadBalancerAttributeNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The specified load balancer attribute could not be found.

\n " } ], "documentation": "\n

Returns detailed information about all of the attributes associated with the specified load balancer.

\n " }, "DescribeLoadBalancerPolicies": { "name": "DescribeLoadBalancerPolicies", "input": { "shape_name": "DescribeLoadBalancerPoliciesInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n \t

\n \tThe mnemonic name associated with the load balancer.\n \tIf no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.\n \t

\n " }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n \t

\n \t The names of load balancer policies you've created or Elastic Load Balancing sample policy names.\n \t

\n " } }, "documentation": "\n " }, "output": { "shape_name": "DescribeLoadBalancerPoliciesOutput", "type": "structure", "members": { "PolicyDescriptions": { "shape_name": "PolicyDescriptions", "type": "list", "members": { "shape_name": "PolicyDescription", "type": "structure", "members": { "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

\n The name of the policy associated with the load balancer.\n

\n " }, "PolicyTypeName": { "shape_name": "PolicyTypeName", "type": "string", "documentation": "\n

\n The name of the policy type associated with the load balancer.\n

\n " }, "PolicyAttributeDescriptions": { "shape_name": "PolicyAttributeDescriptions", "type": "list", "members": { "shape_name": "PolicyAttributeDescription", "type": "structure", "members": { "AttributeName": { "shape_name": "AttributeName", "type": "string", "documentation": "\n

\n The name of the attribute associated with the policy.\n

\n " }, "AttributeValue": { "shape_name": "AttributeValue", "type": "string", "documentation": "\n

\n The value of the attribute associated with the policy.\n

\n " } }, "documentation": "\n

\n The PolicyAttributeDescription data type.\n This data type is used to describe the attributes and values\n associated with a policy.\n

\n " }, "documentation": "\n

\n A list of policy attribute description structures.\n

\n " } }, "documentation": "\n

\n The PolicyDescription data type.\n

\n " }, "documentation": "\n \t

\n \tA list of policy description structures.\n \t

\n " } }, "documentation": "\n

The output for the DescribeLoadBalancerPolicies action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "PolicyNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more specified policies were not found.\n

\n " } ], "documentation": "\n

Returns detailed descriptions of the policies.\n If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer.\n If you specify a policy name associated with your load balancer, the action returns the description of that policy. \n If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies.\n The names of the sample policies have the ELBSample- prefix.\n

\n \n \n Description of all the policies associated with a load balancer \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyLoadBalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicies\n&AUTHPARAMS \n \n \n \n \n MyDurationStickyPolicy\n LBCookieStickinessPolicyType\n \n \n CookieExpirationPeriod\n 60\n \n \n \n \n MyAppStickyPolicy\n AppCookieStickinessPolicyType\n \n \n CookieName\n MyAppCookie\n \n \n \n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n Description of a specified policy associated with the load balancer \n https://elasticloadbalancing.amazonaws.com/?PolicyNames.member.1=EnableProxyProtocol\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicies\n&AUTHPARAMS \n \n \n \n \n EnableProxyProtocol\n ProxyProtocolPolicyType\n \n \n ProxyProtocol\n true\n \n \n \n \n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n " }, "DescribeLoadBalancerPolicyTypes": { "name": "DescribeLoadBalancerPolicyTypes", "input": { "shape_name": "DescribeLoadBalancerPolicyTypesInput", "type": "structure", "members": { "PolicyTypeNames": { "shape_name": "PolicyTypeNames", "type": "list", "members": { "shape_name": "PolicyTypeName", "type": "string", "documentation": null }, "documentation": "\n \t

\n \tSpecifies the name of the policy types. If no names are specified,\n \treturns the description of all\n \tthe policy types defined by Elastic Load Balancing service.\n \t

\n " } }, "documentation": "\n \t" }, "output": { "shape_name": "DescribeLoadBalancerPolicyTypesOutput", "type": "structure", "members": { "PolicyTypeDescriptions": { "shape_name": "PolicyTypeDescriptions", "type": "list", "members": { "shape_name": "PolicyTypeDescription", "type": "structure", "members": { "PolicyTypeName": { "shape_name": "PolicyTypeName", "type": "string", "documentation": "\n

\n The name of the policy type.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

\n A human-readable description of the policy type.\n

\n " }, "PolicyAttributeTypeDescriptions": { "shape_name": "PolicyAttributeTypeDescriptions", "type": "list", "members": { "shape_name": "PolicyAttributeTypeDescription", "type": "structure", "members": { "AttributeName": { "shape_name": "AttributeName", "type": "string", "documentation": "\n

\n The name of the attribute associated with the policy type.\n

\n " }, "AttributeType": { "shape_name": "AttributeType", "type": "string", "documentation": "\n

\n The type of attribute. For example, Boolean, Integer, etc.\n

\n " }, "Description": { "shape_name": "Description", "type": "string", "documentation": "\n

\n A human-readable description of the attribute.\n

\n " }, "DefaultValue": { "shape_name": "DefaultValue", "type": "string", "documentation": "\n

\n The default value of the attribute, if applicable.\n

\n " }, "Cardinality": { "shape_name": "Cardinality", "type": "string", "documentation": "\n

\n The cardinality of the attribute. Valid Values:\n

\n

\n " } }, "documentation": "\n

\n The PolicyAttributeTypeDescription data type. This data type is used to describe values\n that are acceptable for the policy attribute.\n

\n " }, "documentation": "\n

\n The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service.\n

\n " } }, "documentation": "\n

\n The PolicyTypeDescription data type.\n

\n " }, "documentation": "\n \t

\n \tList of policy type description structures of the specified policy type.\n \tIf no policy type names are specified,\n \treturns the description of all the policy types defined by Elastic Load Balancing service.\n \t

\n " } }, "documentation": "\n \t

\n \tThe output for the DescribeLoadBalancerPolicyTypes action.\n \t

\n " }, "errors": [ { "shape_name": "PolicyTypeNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more of the specified policy types do not exist.\n

\n " } ], "documentation": "\n \t

\n \tReturns meta-information on the specified load balancer policies defined by the\n \tElastic Load Balancing service. The policy types that are\n \treturned from this action can be used in a CreateLoadBalancerPolicy action to\n \tinstantiate specific policy configurations that will be applied to a load balancer.\n \t

\n \n \n Partial description of all the policy types defined by Elastic Load Balancing for your account \n https://elasticloadbalancing.amazonaws.com/?Version=2012-06-01\n&Action=DescribeLoadBalancerPolicyTypes\n&AUTHPARAMS \n \n\n SSLNegotiationPolicyType\n < . . . .>\n BackendServerAuthenticationPolicyType\n < . . . .>\n PublicKeyPolicyType\n < . . . .>\n AppCookieStickinessPolicyType\n < . . . .>\n LBCookieStickinessPolicyType\n < . . . .>\n ProxyProtocolPolicyType\n < . . . .>\n\n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\t\n \n \n \n Description of ProxyProtocolPolicyType \n https://elasticloadbalancing.amazonaws.com/?PolicyTypeNames.member.1=ProxyProtocolPolicyType\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicyTypes\n&AUTHPARAMS \n \n \n \n \n \n \n ProxyProtocol\n Boolean\n ONE\n \n \n ProxyProtocolPolicyType\n Policy that controls whether to include the IP address and port of the originating request for TCP messages.\n This policy operates on TCP/SSL listeners only\n \n \n \n \n 1549581b-12b7-11e3-895e-1334aEXAMPLE\n \n\n \n \n \n \n " }, "DescribeLoadBalancers": { "name": "DescribeLoadBalancers", "input": { "shape_name": "DescribeAccessPointsInput", "type": "structure", "members": { "LoadBalancerNames": { "shape_name": "LoadBalancerNames", "type": "list", "members": { "shape_name": "AccessPointName", "type": "string", "documentation": null }, "documentation": "\n

\n A list of load balancer names associated with the account.\n

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

\n An optional parameter reserved for future use.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe input for the DescribeLoadBalancers action.\n\t\t

\n " }, "output": { "shape_name": "DescribeAccessPointsOutput", "type": "structure", "members": { "LoadBalancerDescriptions": { "shape_name": "LoadBalancerDescriptions", "type": "list", "members": { "shape_name": "LoadBalancerDescription", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n Specifies the name associated with the load balancer.\n

\n " }, "DNSName": { "shape_name": "DNSName", "type": "string", "documentation": "\n

\n Specifies the external DNS name associated with the load balancer.\n

\n " }, "CanonicalHostedZoneName": { "shape_name": "DNSName", "type": "string", "documentation": "\n

\n Provides the name of the Amazon Route 53 hosted zone that is associated\n with the load balancer. For information on how to associate your load\n balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing\n in the Elastic Load Balancing Developer Guide.\n

\n " }, "CanonicalHostedZoneNameID": { "shape_name": "DNSName", "type": "string", "documentation": "\n

\n Provides the ID of the Amazon Route 53 hosted zone name that is associated\n with the load balancer. For information on how to associate or disassociate your load\n balancer with a hosted zone, go to Using Domain Names With Elastic Load Balancing\n in the Elastic Load Balancing Developer Guide. \n

\n " }, "ListenerDescriptions": { "shape_name": "ListenerDescriptions", "type": "list", "members": { "shape_name": "ListenerDescription", "type": "structure", "members": { "Listener": { "shape_name": "Listener", "type": "structure", "members": { "Protocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n

\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "LoadBalancerPort": { "shape_name": "AccessPointPort", "type": "integer", "documentation": "\n

\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "InstanceProtocol": { "shape_name": "Protocol", "type": "string", "documentation": "\n \t

\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t

\n \t\n \tIf the front-end protocol is HTTP or HTTPS, InstanceProtocol has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t\n \t\n \tIf there is another listener with the same InstancePort whose InstanceProtocol is secure,\n \ti.e., HTTPS or SSL, the listener's InstanceProtocol has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP,\n the listener's InstanceProtocol must be either HTTP or TCP. \n \t\n " }, "InstancePort": { "shape_name": "InstancePort", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n

\n ", "required": true }, "SSLCertificateId": { "shape_name": "SSLCertificateId", "type": "string", "documentation": "\n

\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n UploadServerCertificate \t\n API.

\n " } }, "documentation": "\n

\n The Listener data type.\n

\n " }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n

\n A list of policies enabled for this listener. \n An empty list indicates that no policies are enabled.\n

\n " } }, "documentation": "\n

\n The ListenerDescription data type. \n

\n " }, "documentation": "\n

\n LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned\n in a list of tuples in the ListenerDescriptions element.\n

\n " }, "Policies": { "shape_name": "Policies", "type": "structure", "members": { "AppCookieStickinessPolicies": { "shape_name": "AppCookieStickinessPolicies", "type": "list", "members": { "shape_name": "AppCookieStickinessPolicy", "type": "structure", "members": { "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.\n

\n " }, "CookieName": { "shape_name": "CookieName", "type": "string", "documentation": "\n

The name of the application cookie used for stickiness.\n

\n \n " } }, "documentation": "\n

The AppCookieStickinessPolicy data type.\n

\n " }, "documentation": "\n

\n A list of the AppCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.\n

\n " }, "LBCookieStickinessPolicies": { "shape_name": "LBCookieStickinessPolicies", "type": "list", "members": { "shape_name": "LBCookieStickinessPolicy", "type": "structure", "members": { "PolicyName": { "shape_name": "PolicyName", "type": "string", "documentation": "\n

The name for the policy being created. The name must be unique within the set of policies for this load balancer.\n

\n " }, "CookieExpirationPeriod": { "shape_name": "CookieExpirationPeriod", "type": "long", "documentation": "\n

The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.\n

\n " } }, "documentation": "\n

The LBCookieStickinessPolicy data type.\n

\n " }, "documentation": "\n

\n A list of LBCookieStickinessPolicy objects created with CreateAppCookieStickinessPolicy.\n

\n " }, "OtherPolicies": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n

\n A list of policy names other than the stickiness policies.\n

\n " } }, "documentation": "\n \t\t

\n \t\tProvides a list of policies defined for the load balancer.\n \t\t

\n \t" }, "BackendServerDescriptions": { "shape_name": "BackendServerDescriptions", "type": "list", "members": { "shape_name": "BackendServerDescription", "type": "structure", "members": { "InstancePort": { "shape_name": "InstancePort", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

\n Provides the port on which the back-end server is listening.\n

\n " }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n

\n Provides a list of policy names enabled for the back-end server.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeLoadBalancers action to describe the configuration of the back-end server.\n

\n " }, "documentation": "\n

\n Contains a list of back-end server descriptions.\n

\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n Specifies a list of Availability Zones.\n

\n " }, "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n Provides a list of VPC subnet IDs for the load balancer.\n

\n " }, "VPCId": { "shape_name": "VPCId", "type": "string", "documentation": "\n

\n Provides the ID of the VPC attached to the load balancer.\n

\n " }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n Provides a list of EC2 instance IDs for the load balancer.\n

\n " }, "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Target": { "shape_name": "HealthCheckTarget", "type": "string", "documentation": "\n

\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n

\n \n

\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n

\n

SSL is also specified as SSL: port pair, for example, SSL:5000.

\n

\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n

\n

\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n

\n \n ", "required": true }, "Interval": { "shape_name": "HealthCheckInterval", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n

\n ", "required": true }, "Timeout": { "shape_name": "HealthCheckTimeout", "type": "integer", "min_length": 1, "max_length": 300, "documentation": "\n

\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n

\n \n This value must be less than the Interval value.\n \n ", "required": true }, "UnhealthyThreshold": { "shape_name": "UnhealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe failures required\n before moving the instance to the Unhealthy state.\n

\n ", "required": true }, "HealthyThreshold": { "shape_name": "HealthyThreshold", "type": "integer", "min_length": 2, "max_length": 10, "documentation": "\n

\n Specifies the number of consecutive health probe successes required before\n moving the instance to the Healthy state.\n

\n ", "required": true } }, "documentation": "\n

\n Specifies information regarding the\n various health probes conducted on the load balancer.\n

\n " }, "SourceSecurityGroup": { "shape_name": "SourceSecurityGroup", "type": "structure", "members": { "OwnerAlias": { "shape_name": "SecurityGroupOwnerAlias", "type": "string", "documentation": "\n

\n Owner of the source security group. Use this value for the \n --source-group-user parameter of the ec2-authorize\n command in the Amazon EC2 command line tool.\n

\n " }, "GroupName": { "shape_name": "SecurityGroupName", "type": "string", "documentation": "\n

\n Name of the source security group. Use this value for the \n --source-group parameter of the ec2-authorize\n command in the Amazon EC2 command line tool.\n

\n " } }, "documentation": "\n

\n The security group that you can use as part of your inbound rules for \n your load balancer's back-end Amazon EC2 application instances. \n To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this\n source security group as the inbound source. \n

\n " }, "SecurityGroups": { "shape_name": "SecurityGroups", "type": "list", "members": { "shape_name": "SecurityGroupId", "type": "string", "documentation": null }, "documentation": "\n

\n The security groups the load balancer is a member of (VPC only).\n

\n " }, "CreatedTime": { "shape_name": "CreatedTime", "type": "timestamp", "documentation": "\n

\n Provides the date and time the load balancer was created.\n

\n " }, "Scheme": { "shape_name": "LoadBalancerScheme", "type": "string", "documentation": "\n

Specifies the type of load balancer.

\n\n

If the Scheme is internet-facing, the load balancer\n has a publicly resolvable DNS name that resolves to public IP addresses.

\n \n

If the Scheme is internal, the load balancer has a publicly resolvable\n DNS name that resolves to private IP addresses.

\n \n

This option is only available for load balancers attached to an Amazon VPC.

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of DescribeLoadBalancers.\n

\n " }, "documentation": "\n

\n A list of load balancer description structures.\n

\n " }, "NextMarker": { "shape_name": "Marker", "type": "string", "documentation": "\n

\n An optional parameter reserved for future use.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe output for the DescribeLoadBalancers action.\n\t\t

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " } ], "documentation": "\n

\n Returns detailed configuration information for all the load balancers created for the account.\n If you specify load balancer names, the action returns configuration information of the specified\n load balancers.

\n \n In order to retrieve this information, you must provide the same account credentials \n that was used to create the load balancer.\n \n \n Description of a specified load balancer \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerNames.member.1=MyLoadBalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancers\n&AUTHPARAMS \n \n \n \n \n MyLoadBalancer\n 2013-05-24T21:15:31.280Z\n \n 90\n HTTP:80/\n 2\n 60\n 10\n \n \n \n \n \n HTTP\n 80\n HTTP\n 80\n \n \n \n \n \n i-e4cbe38d\n \n \n \n \n \n \n \n \n us-east-1a\n \n ZZZZZZZZZZZ123X\n MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com\n internet-facing\n \n amazon-elb\n amazon-elb-sg\n \n MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com\n \n \n \n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\t\n \n \n \n ", "pagination": { "input_token": "Marker", "output_token": "NextMarker", "result_key": "LoadBalancerDescriptions", "py_input_token": "marker" } }, "DetachLoadBalancerFromSubnets": { "name": "DetachLoadBalancerFromSubnets", "input": { "shape_name": "DetachLoadBalancerFromSubnetsInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer to be detached. \n

\n ", "required": true }, "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of subnet IDs to remove from the set of configured subnets for the load balancer.\n

\n ", "required": true } }, "documentation": "\n

\n The input for the DetachLoadBalancerFromSubnets action. \n

\n " }, "output": { "shape_name": "DetachLoadBalancerFromSubnetsOutput", "type": "structure", "members": { "Subnets": { "shape_name": "Subnets", "type": "list", "members": { "shape_name": "SubnetId", "type": "string", "documentation": null }, "documentation": "\n

\n A list of subnet IDs the load balancer is now attached to. \n

\n " } }, "documentation": "\n

\n The output for the DetachLoadBalancerFromSubnets action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. \n

\n

\n After a subnet is removed all of the EC2 instances registered with the load balancer that are \n in the removed subnet will go into the OutOfService state. When a subnet is removed, the load balancer\n will balance the traffic among the remaining routable subnets for the load balancer. \n

\n \n https://elasticloadbalancing.amazonaws.com/?Subnets.member.1=subnet-119f0078\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=DetachLoadBalancerFromSubnets\n&AUTHPARAMS \n \n \n \n subnet-159f007c\n subnet-3561b05e\n \n \n \n 07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE\n \n\n \n \n " }, "DisableAvailabilityZonesForLoadBalancer": { "name": "DisableAvailabilityZonesForLoadBalancer", "input": { "shape_name": "RemoveAvailabilityZonesInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer. \n

\n ", "required": true }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n A list of Availability Zones to be removed from the load balancer.\n

\n \n There must be at least one Availability Zone\n registered with a load balancer at all times. \n Specified Availability Zones must be in the same region.\n \n ", "required": true } }, "documentation": "\n\t\t

\n\t\tThe input for the DisableAvailabilityZonesForLoadBalancer action.\n\t\t

\n " }, "output": { "shape_name": "RemoveAvailabilityZonesOutput", "type": "structure", "members": { "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n A list of updated Availability Zones for the load balancer.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe output for the DisableAvailabilityZonesForLoadBalancer action.\n\t\t

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Removes the specified EC2 Availability Zones from\n the set of configured Availability Zones for the load balancer.\n

\n

\n There must be at least one Availability Zone registered\n with a load balancer at all times. \n Once an Availability Zone is removed, all the instances\n registered with the load balancer that are in the removed\n Availability Zone go into the OutOfService state. Upon Availability\n Zone removal, the load balancer attempts to equally balance\n the traffic among its remaining usable Availability Zones.\n Trying to remove an Availability Zone that was not associated with\n the load balancer does nothing.\n

\n

For more information, see Disable an Availability Zone from a Load-Balanced Application\n in the Elastic Load Balancing Developer Guide.

\n \n \n https://elasticloadbalancing.amazonaws.com/?AvailabilityZones.member.1=us-east-1a\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=DisableAvailabilityZonesForLoadBalancer\n&AUTHPARAMS \n \n \n \n us-east-1b\n \n \n \n ba6267d5-2566-11e3-9c6d-eb728EXAMPLE\n \n\n \n \n \n " }, "EnableAvailabilityZonesForLoadBalancer": { "name": "EnableAvailabilityZonesForLoadBalancer", "input": { "shape_name": "AddAvailabilityZonesInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer. \n

\n ", "required": true }, "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n A list of new Availability Zones for the load balancer.\n Each Availability Zone must be in the same region as the load balancer.\n

\n ", "required": true } }, "documentation": "\n\t\t

\n\t\tThe input for the EnableAvailabilityZonesForLoadBalancer action.\n\t\t

\n " }, "output": { "shape_name": "AddAvailabilityZonesOutput", "type": "structure", "members": { "AvailabilityZones": { "shape_name": "AvailabilityZones", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "string", "documentation": null }, "documentation": "\n

\n An updated list of Availability Zones for the load balancer.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe output for the EnableAvailabilityZonesForLoadBalancer action.\n\t\t

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " } ], "documentation": "\n

\n Adds one or more EC2 Availability Zones to the load balancer.\n

\n

\n The load balancer evenly distributes requests across all\n its registered Availability Zones that contain instances. \n

\n \n The new EC2 Availability Zones to be added must be in the same\n EC2 Region as the Availability Zones for which the\n load balancer was created.\n \n

For more information, see Expand a Load Balanced Application to an Additional Availability Zone\n in the Elastic Load Balancing Developer Guide.

\n \n \n Enable Availability Zone us-east-1c for my-test-loadbalancer. \n https://elasticloadbalancing.amazonaws.com/?AvailabilityZones.member.1=us-east-1c\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=EnableAvailabilityZonesForLoadBalancer\n&AUTHPARAMS \n \n \n \n us-east-1a\n us-east-1c\n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n " }, "ModifyLoadBalancerAttributes": { "name": "ModifyLoadBalancerAttributes", "input": { "shape_name": "ModifyLoadBalancerAttributesInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

The name of the load balancer.

\n ", "required": true }, "LoadBalancerAttributes": { "shape_name": "LoadBalancerAttributes", "type": "structure", "members": { "CrossZoneLoadBalancing": { "shape_name": "CrossZoneLoadBalancing", "type": "structure", "members": { "Enabled": { "shape_name": "CrossZoneLoadBalancingEnabled", "type": "boolean", "documentation": "\n

Specifies whether cross-zone load balancing is enabled for the load balancer.

\n ", "required": true } }, "documentation": "\n

The name of the load balancer attribute.

\n " } }, "documentation": "\n

Attributes of the load balancer.

\n ", "required": true } }, "documentation": "\n

The input for the ModifyLoadBalancerAttributes action.

\n " }, "output": { "shape_name": "ModifyLoadBalancerAttributesOutput", "type": "structure", "members": {}, "documentation": "\n

The output for the ModifyLoadBalancerAttributes action.

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "LoadBalancerAttributeNotFoundException", "type": "structure", "members": {}, "documentation": "\n

The specified load balancer attribute could not be found.

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

Modifies the attributes of a specified load balancer.

\n " }, "RegisterInstancesWithLoadBalancer": { "name": "RegisterInstancesWithLoadBalancer", "input": { "shape_name": "RegisterEndPointsInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name associated with the load balancer.\n The name must be unique within your set of load balancers. \n

\n ", "required": true }, "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n A list of instance IDs that should be registered with the load balancer.

\n \n ", "required": true } }, "documentation": "\n\t\t

\n\t\tThe input for the RegisterInstancesWithLoadBalancer action.\n\t\t

\n " }, "output": { "shape_name": "RegisterEndPointsOutput", "type": "structure", "members": { "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

\n Provides an EC2 instance ID.\n

\n " } }, "documentation": "\n

\n The Instance data type.\n

\n " }, "documentation": "\n

\n An updated list of instances for the load balancer.\n

\n " } }, "documentation": "\n\t\t

\n\t\tThe output for the RegisterInstancesWithLoadBalancer action.\n\t\t

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "InvalidEndPointException", "type": "structure", "members": {}, "documentation": "\n

\n The specified EndPoint is not valid.\n

\n " } ], "documentation": "\n

\n Adds new instances to the load balancer.\n

\n

\n Once the instance is registered, it starts receiving traffic\n and requests from the load balancer. Any instance that is not\n in any of the Availability Zones registered for the load balancer\n will be moved to the OutOfService state. It will move to the\n InService state when the Availability Zone is added to the load balancer.\n

\n

When an instance registered with a load balancer is stopped and then restarted, \n the IP addresses associated with the instance changes. Elastic Load Balancing \n cannot recognize the new IP address, which prevents it from routing traffic to\n the instances. We recommend that you de-register your Amazon EC2 instances from\n your load balancer after you stop your instance, and then register the load \n balancer with your instance after you've restarted. To de-register your instances \n from load balancer, use DeregisterInstancesFromLoadBalancer action.

\n

For more information, see De-register and Register Amazon EC2 Instances \n in the Elastic Load Balancing Developer Guide.

\n \n In order for this call to be successful, you must provide the same \n account credentials as those that were used to create the load balancer.\n \n \n Completion of this API does not guarantee that operation has completed.\n Rather, it means that the request has been registered and the\n changes will happen shortly.\n \n

You can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.

\n \n \n https://elasticloadbalancing.amazonaws.com/?Instances.member.1.InstanceId=i-315b7e51\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=RegisterInstancesWithLoadBalancer\n&AUTHPARAMS \n \n \n \n \n i-315b7e51\n \n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n \n " }, "SetLoadBalancerListenerSSLCertificate": { "name": "SetLoadBalancerListenerSSLCertificate", "input": { "shape_name": "SetLoadBalancerListenerSSLCertificateInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name of the load balancer. \n

\n ", "required": true }, "LoadBalancerPort": { "shape_name": "AccessPointPort", "type": "integer", "documentation": "\n

\n The port that uses the specified SSL certificate. \n

\n ", "required": true }, "SSLCertificateId": { "shape_name": "SSLCertificateId", "type": "string", "documentation": "\n

\n The Amazon Resource Number (ARN) of the SSL certificate chain to use. \n For more information on SSL certificates, see \n \n Managing Server Certificates in the AWS Identity and Access Management User Guide.

\n ", "required": true } }, "documentation": "\n

\n The input for the SetLoadBalancerListenerSSLCertificate action.\n

\n " }, "output": { "shape_name": "SetLoadBalancerListenerSSLCertificateOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the SetLoadBalancerListenerSSLCertificate action.\n

\n " }, "errors": [ { "shape_name": "CertificateNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n

\n " }, { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "ListenerNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n Load balancer does not have a listener configured at the given port.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Sets the certificate that terminates the specified listener's SSL connections. \n The specified certificate replaces any prior certificate that was used on the same load balancer and port. \n

\n

For more information on updating your SSL certificate, see Updating an SSL Certificate for a Load Balancer\n in the Elastic Load Balancing Developer Guide.

\n \n \n \n https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyInternalLoadBalancer\n&SSLCertificateId=arn:aws:iam::123456789012:server-certificate/testcert\n&LoadBalancerPort=443\n&Version=2012-06-01\n&Action=SetLoadBalancerListenerSSLCertificate\n&AUTHPARAMS \n \n \n\n 83c88b9d-12b7-11e3-8b82-87b12EXAMPLE\n\n\n \n \n \n " }, "SetLoadBalancerPoliciesForBackendServer": { "name": "SetLoadBalancerPoliciesForBackendServer", "input": { "shape_name": "SetLoadBalancerPoliciesForBackendServerInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The mnemonic name associated with the load balancer.\n This name must be unique within the set of your load balancers.\n

\n ", "required": true }, "InstancePort": { "shape_name": "EndPointPort", "type": "integer", "documentation": "\n

\n The port number associated with the back-end server.\n

\n ", "required": true }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n

\n List of policy names to be set. If the list is empty, then all current polices are\n removed from the back-end server.\n

\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "SetLoadBalancerPoliciesForBackendServerOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the SetLoadBalancerPoliciesForBackendServer action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "PolicyNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more specified policies were not found.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using CreateLoadBalancerPolicy, \n they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.\n

\n \n

The SetLoadBalancerPoliciesForBackendServer replaces the current set of policies associated with the specified instance port. \n Every time you use this action to enable the policies, use the PolicyNames parameter to list all the policies you want to enable.

\n \n \n https://elasticloadbalancing.amazonaws.com/?InstancePort=80\n&PolicyNames.member.1=EnableProxyProtocol\n&PolicyNames.member.2=MyPolicyName2\n&PolicyNames.member.3=MyPolicyName3\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=SetLoadBalancerPoliciesForBackendServer\n&AUTHPARAMS \n \n \n \n 0eb9b381-dde0-11e2-8d78-6ddbaEXAMPLE\n \n \n \n \n

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies action to verify that the policy has been associated with the back-end server.

\n " }, "SetLoadBalancerPoliciesOfListener": { "name": "SetLoadBalancerPoliciesOfListener", "input": { "shape_name": "SetLoadBalancerPoliciesOfListenerInput", "type": "structure", "members": { "LoadBalancerName": { "shape_name": "AccessPointName", "type": "string", "documentation": "\n

\n The name of the load balancer. \n

\n ", "required": true }, "LoadBalancerPort": { "shape_name": "AccessPointPort", "type": "integer", "documentation": "\n

\n The external port of the load balancer to associate the policy. \n

\n ", "required": true }, "PolicyNames": { "shape_name": "PolicyNames", "type": "list", "members": { "shape_name": "PolicyName", "type": "string", "documentation": null }, "documentation": "\n

\n List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener.\n

\n ", "required": true } }, "documentation": "\n

\n The input for the SetLoadBalancerPoliciesOfListener action.\n

\n " }, "output": { "shape_name": "SetLoadBalancerPoliciesOfListenerOutput", "type": "structure", "members": {}, "documentation": "\n

\n The output for the SetLoadBalancerPoliciesOfListener action.\n

\n " }, "errors": [ { "shape_name": "AccessPointNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n The specified load balancer could not be found.\n

\n " }, { "shape_name": "PolicyNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n One or more specified policies were not found.\n

\n " }, { "shape_name": "ListenerNotFoundException", "type": "structure", "members": {}, "documentation": "\n

\n Load balancer does not have a listener configured at the given port.\n

\n " }, { "shape_name": "InvalidConfigurationRequestException", "type": "structure", "members": {}, "documentation": "\n

\n Requested configuration change is invalid.\n

\n " } ], "documentation": "\n

\n Associates, updates, or disables a policy with a listener on the load balancer. \n You can associate multiple policies with a listener. \n

\n \n Associate MySSLNegotiationPolicy with the load balancer port 443 on the MyInternalLoadbalancer load balancer. \n https://elasticloadbalancing.amazonaws.com/?PolicyNames.member.1=MySSLNegotiationPolicy\n&LoadBalancerName=MyInternalLoadBalancer\n&LoadBalancerPort=443\n&Version=2012-06-01\n&Action=SetLoadBalancerPoliciesOfListener\n&AUTHPARAMS \n \n \n \n 07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE\n \n\n \n \n \n " } }, "xmlnamespace": "http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/", "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://elasticloadbalancing.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "pagination": { "DescribeLoadBalancers": { "input_token": "Marker", "output_token": "NextMarker", "result_key": "LoadBalancerDescriptions", "py_input_token": "marker" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/emr.json0000644000175000017500000066601512254746566017744 0ustar takakitakaki{ "api_version": "2009-03-31", "type": "json", "json_version": 1.1, "target_prefix": "ElasticMapReduce", "signature_version": "v4", "service_full_name": "Amazon Elastic MapReduce", "service_abbreviation": "Amazon EMR", "timestamp_format": "unixTimestamp", "endpoint_prefix": "elasticmapreduce", "documentation": "\n

This is the Amazon Elastic MapReduce API Reference. This guide provides descriptions and\n samples of the Amazon Elastic MapReduce APIs.

\n\n

Amazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.

\n\n ", "operations": { "AddInstanceGroups": { "name": "AddInstanceGroups", "input": { "shape_name": "AddInstanceGroupsInput", "type": "structure", "members": { "InstanceGroups": { "shape_name": "InstanceGroupConfigList", "type": "list", "members": { "shape_name": "InstanceGroupConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Friendly name given to the instance group.

\n " }, "Market": { "shape_name": "MarketType", "type": "string", "enum": [ "ON_DEMAND", "SPOT" ], "documentation": "\n

Market type of the Amazon EC2 instances used to create a cluster node.

\n " }, "InstanceRole": { "shape_name": "InstanceRoleType", "type": "string", "enum": [ "MASTER", "CORE", "TASK" ], "documentation": "\n

The role of the instance group in the cluster.

\n ", "required": true }, "BidPrice": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Bid price for each Amazon EC2 instance in the\n instance group when launching nodes as Spot Instances, expressed in USD.

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The Amazon EC2 instance type for all instances in the instance group.

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

Target number of instances for the instance group.

\n ", "required": true } }, "documentation": "\n

Configuration defining a new instance group.

\n " }, "documentation": "\n

Instance Groups to add.

\n ", "required": true }, "JobFlowId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Job flow in which to add the instance groups.

\n ", "required": true } }, "documentation": "\n

Input to an AddInstanceGroups call.

\n " }, "output": { "shape_name": "AddInstanceGroupsOutput", "type": "structure", "members": { "JobFlowId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The job flow ID in which the instance groups are added.

\n " }, "InstanceGroupIds": { "shape_name": "InstanceGroupIdsList", "type": "list", "members": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": null }, "documentation": "\n

Instance group IDs of the newly created instance groups.

\n " } }, "documentation": "\n

Output from an AddInstanceGroups call.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

AddInstanceGroups adds an instance group to a running cluster.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.AddInstanceGroups\nContent-Length: 168\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T223346Z\nX-Amz-Content-Sha256: ac5a7193b1283898dd822a4b16ca36963879bb010d2dbe57198439973ab2a7d3\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=4c5e7eb762ea45f292a5cd1a1cc56ed60009e19a9dba3d6e5e4e67e96d43af11\nAccept: */*\n\n\n{\n \"JobFlowId\": \"j-3U7TSX5GZFD8Y\",\n \"InstanceGroups\": [{\n \"Name\": \"Task Instance Group\",\n \"InstanceRole\": \"TASK\",\n \"InstanceCount\": 2,\n \"InstanceType\": \"m1.small\",\n \"Market\": \"ON_DEMAND\"\n }]\n}\n\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 71\nDate: Mon, 15 Jul 2013 22:33:47 GMT\n\n{\n \"InstanceGroupIds\": [\"ig-294A6A2KWT4WB\"],\n \"JobFlowId\": \"j-3U7TSX5GZFD8Y\"\n}\n\n\n \n\n " }, "AddJobFlowSteps": { "name": "AddJobFlowSteps", "input": { "shape_name": "AddJobFlowStepsInput", "type": "structure", "members": { "JobFlowId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

A string that uniquely identifies the job flow. This identifier is returned by\n RunJobFlow and can also be obtained from DescribeJobFlows.

\n ", "required": true }, "Steps": { "shape_name": "StepConfigList", "type": "list", "members": { "shape_name": "StepConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the job flow step.

\n ", "required": true }, "ActionOnFailure": { "shape_name": "ActionOnFailure", "type": "string", "enum": [ "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE" ], "documentation": "\n

The action to take if the job flow step fails.

\n " }, "HadoopJarStep": { "shape_name": "HadoopJarStepConfig", "type": "structure", "members": { "Properties": { "shape_name": "KeyValueList", "type": "list", "members": { "shape_name": "KeyValue", "type": "structure", "members": { "Key": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The unique identifier of a key value pair.

\n " }, "Value": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The value part of the identified key.

\n " } }, "documentation": "\n

A key value pair.

\n " }, "documentation": "\n

A list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

\n " }, "Jar": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

A path to a JAR file run during the step.

\n ", "required": true }, "MainClass": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a Main-Class in its manifest file.

\n " }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of command line arguments passed to the JAR file's main function when executed.

\n " } }, "documentation": "\n

The JAR file used for the job flow step.

\n ", "required": true } }, "documentation": "\n

Specification of a job flow step.

\n " }, "documentation": "\n

A list of StepConfig to be executed by the job flow.

\n ", "required": true } }, "documentation": "\n

The input argument to the AddJobFlowSteps operation.

\n " }, "output": { "shape_name": "AddJobFlowStepsOutput", "type": "structure", "members": { "StepIds": { "shape_name": "StepIdsList", "type": "list", "members": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": null }, "documentation": "\n

The identifiers of the list of steps added to the job flow.

\n " } }, "documentation": "\n

The output for the AddJobFlowSteps operation.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed\n in each job flow.

\n

If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

\n

A step specifies the location of a JAR file stored either on the master node of the job\n flow or in Amazon S3. Each step is performed by the main function of the main class of the\n JAR file. The main class can be specified either in the manifest of the JAR or by using the\n MainFunction parameter of the step.

\n

Elastic MapReduce executes each step in the order listed. For a step to be considered\n complete, the main function must exit with a zero exit code and all Hadoop jobs started\n while the step was running must have completed and run successfully.

\n

You can only add steps to a job flow that is in one of the following states: STARTING,\n BOOTSTRAPPING, RUNNING, or WAITING.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.AddJobFlowSteps\nContent-Length: 426\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T210948Z\nX-Amz-Content-Sha256: 9e5ad0a93c22224947ce98eea94f766103d91b28fa82eb60d0cb8b6f9555a6b2\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=2a2393390760ae85eb74ee3a539e1d758bfdd8815a1a6d6f14d4a2fbcfdcd5b7\nAccept: */*\n\n{\n \"JobFlowId\": \"j-3TS0OIYO4NFN\",\n \"Steps\": [{\n \"Name\": \"Example Jar Step\",\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Jar\": \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/cloudburst.jar\",\n \"Args\": [\n \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/input\\\\/s_suis.br\",\n \"s3n:\\\\/\\\\/elasticmapreduce\\\\/samples\\\\/cloudburst\\\\/input\\\\/100k.br\",\n \"s3n:\\\\/\\\\/examples-bucket\\\\/cloudburst\\\\/output\",\n \"36\",\n \"3\",\n \"0\",\n \"1\",\n \"240\",\n \"48\",\n \"24\",\n \"24\",\n \"128\",\n \"16\"\n ]\n }\n }]\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 6514261f-ee5b-11e2-9345-5332e9ab2e6d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:05:07 GMT\n\n \n \n " }, "AddTags": { "name": "AddTags", "input": { "shape_name": "AddTagsInput", "type": "structure", "members": { "ResourceId": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined key, which is the minimum required information for a valid tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined value, which is optional in a tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " } }, "documentation": "\n

A key/value pair that contains user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "documentation": "\n

A list of tags to associate with a cluster and propagate to Amazon EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

\n " } }, "documentation": "\n

This input identifies a cluster and a list of tags to attach.\n

\n " }, "output": { "shape_name": "AddTagsOutput", "type": "structure", "members": {}, "documentation": "\n

This output indicates the result of adding tags to a resource. \n

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "DescribeCluster": { "name": "DescribeCluster", "input": { "shape_name": "DescribeClusterInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The identifier of the cluster to describe.

\n " } }, "documentation": "\n

This input determines which cluster to describe.

\n " }, "output": { "shape_name": "DescribeClusterOutput", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "Id": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The unique identifier for the cluster.

" }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster.

" }, "Status": { "shape_name": "ClusterStatus", "type": "structure", "members": { "State": { "shape_name": "ClusterState", "type": "string", "enum": [ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS" ], "documentation": "\n

The current state of the cluster.

\n " }, "StateChangeReason": { "shape_name": "ClusterStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "ClusterStateChangeReasonCode", "type": "string", "enum": [ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "USER_REQUEST", "STEP_FAILURE", "ALL_STEPS_COMPLETED" ], "documentation": "\n

The programmatic code for the state change reason.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The descriptive message for the state change reason.

\n " } }, "documentation": "\n

The reason for the cluster status change.

\n " }, "Timeline": { "shape_name": "ClusterTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the cluster.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster was ready to execute steps.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster was terminated.

\n " } }, "documentation": "\n

A timeline that represents the status of a cluster over the lifetime of the cluster.

\n " } }, "documentation": "\n

The current status details about the cluster.

\n " }, "Ec2InstanceAttributes": { "shape_name": "Ec2InstanceAttributes", "type": "structure", "members": { "Ec2KeyName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as\n a user named \"hadoop\".

\n " }, "Ec2SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

\n To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where \n you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal AWS cloud, outside of \n a VPC. \n

\n

\n Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. \n Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.\n

\n " }, "Ec2AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The Availability Zone in which the cluster will run.

\n " }, "IamInstanceProfile": { "shape_name": "String", "type": "string", "documentation": "\n

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

\n " } }, "documentation": "\n

Provides information about the EC2 instances in a cluster grouped by category. For example, EC2 Key Name, Subnet Id, Instance Profile, and so on.

\n " }, "LogUri": { "shape_name": "String", "type": "string", "documentation": "\n

The path to the Amazon S3 location where logs for this cluster are stored.

\n " }, "RequestedAmiVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The AMI version requested for this cluster.

\n " }, "RunningAmiVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The AMI version running on this cluster. This differs from the requested version only if the requested version is a meta version, such as \"latest\".

\n " }, "AutoTerminate": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the cluster should terminate after completing all steps.

\n " }, "TerminationProtected": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or \n user intervention, or in the event of a cluster error.

" }, "VisibleToAllUsers": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and manage the job flow if they have the proper policy permissions set. \n If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

\n " }, "Applications": { "shape_name": "ApplicationList", "type": "list", "members": { "shape_name": "Application", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the application.

" }, "Version": { "shape_name": "String", "type": "string", "documentation": "\n

The version of the application.

" }, "Args": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Arguments for Amazon EMR to pass to the application.

" }, "AdditionalInfo": { "shape_name": "StringMap", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

" } }, "documentation": "\n

An application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

\n \n " }, "documentation": "\n

The applications installed on this cluster.

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined key, which is the minimum required information for a valid tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined value, which is optional in a tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " } }, "documentation": "\n

A key/value pair that contains user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "documentation": "\n

A list of tags associated with cluster.

" } }, "documentation": "\n

This output contains the details for the requested cluster.

\n " } }, "documentation": "\n

This output contains the description of the cluster.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

\n \n " }, "DescribeJobFlows": { "name": "DescribeJobFlows", "input": { "shape_name": "DescribeJobFlowsInput", "type": "structure", "members": { "CreatedAfter": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Return only job flows created after this date and time.

\n " }, "CreatedBefore": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

Return only job flows created before this date and time.

\n " }, "JobFlowIds": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

Return only job flows whose job flow ID is contained in this list.

\n " }, "JobFlowStates": { "shape_name": "JobFlowExecutionStateList", "type": "list", "members": { "shape_name": "JobFlowExecutionState", "type": "string", "enum": [ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "SHUTTING_DOWN", "TERMINATED", "COMPLETED", "FAILED" ], "documentation": "\n

The type of instance.

\n \n \n

A small instance

\n \n \n

A large instance

\n \n \n " }, "documentation": "\n

Return only job flows whose state is contained in this list.

\n " } }, "documentation": "\n

The input for the DescribeJobFlows operation.

\n " }, "output": { "shape_name": "DescribeJobFlowsOutput", "type": "structure", "members": { "JobFlows": { "shape_name": "JobFlowDetailList", "type": "list", "members": { "shape_name": "JobFlowDetail", "type": "structure", "members": { "JobFlowId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The job flow identifier.

\n ", "required": true }, "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the job flow.

\n ", "required": true }, "LogUri": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The location in Amazon S3 where log files for the job are stored.

\n " }, "AmiVersion": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently \n supported by Amazon ElasticMapReduce, go to AMI Versions Supported in Elastic MapReduce in the \n Amazon Elastic MapReduce Developer's Guide.

\n " }, "ExecutionStatusDetail": { "shape_name": "JobFlowExecutionStatusDetail", "type": "structure", "members": { "State": { "shape_name": "JobFlowExecutionState", "type": "string", "enum": [ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "SHUTTING_DOWN", "TERMINATED", "COMPLETED", "FAILED" ], "documentation": "\n

The state of the job flow.

\n ", "required": true }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the job flow.

\n ", "required": true }, "StartDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The start date and time of the job flow.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the job flow was ready to start running bootstrap actions.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The completion date and time of the job flow.

\n " }, "LastStateChangeReason": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

Description of the job flow last changed state.

\n " } }, "documentation": "\n

Describes the execution status of the job flow.

\n ", "required": true }, "Instances": { "shape_name": "JobFlowInstancesDetail", "type": "structure", "members": { "MasterInstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The Amazon EC2 master node instance type.

\n ", "required": true }, "MasterPublicDnsName": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The DNS name of the master node.

\n " }, "MasterInstanceId": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The Amazon EC2 instance identifier of the master node.

\n " }, "SlaveInstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The Amazon EC2 slave node instance type.

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance\n serves as both the master and slave node. If the value is greater than 1, one instance is\n the master node and all others are slave nodes.

\n ", "required": true }, "InstanceGroups": { "shape_name": "InstanceGroupDetailList", "type": "list", "members": { "shape_name": "InstanceGroupDetail", "type": "structure", "members": { "InstanceGroupId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Unique identifier for the instance group.

\n " }, "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Friendly name for the instance group.

\n " }, "Market": { "shape_name": "MarketType", "type": "string", "enum": [ "ON_DEMAND", "SPOT" ], "documentation": "\n

Market type of the Amazon EC2 instances used to create a cluster node.

\n ", "required": true }, "InstanceRole": { "shape_name": "InstanceRoleType", "type": "string", "enum": [ "MASTER", "CORE", "TASK" ], "documentation": "\n

Instance group role in the cluster

\n ", "required": true }, "BidPrice": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Bid price for EC2 Instances when launching nodes as\n Spot Instances, expressed in USD.

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

Amazon EC2 Instance type.

\n ", "required": true }, "InstanceRequestCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

Target number of instances to run in the instance group.

\n ", "required": true }, "InstanceRunningCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

Actual count of running instances.

\n ", "required": true }, "State": { "shape_name": "InstanceGroupState", "type": "string", "enum": [ "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED", "ARRESTED", "SHUTTING_DOWN", "ENDED" ], "documentation": "\n

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

\n ", "required": true }, "LastStateChangeReason": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

Details regarding the state of the instance group.

\n " }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date/time the instance group was created.

\n ", "required": true }, "StartDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date/time the instance group was started.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date/time the instance group was available to the cluster.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date/time the instance group was terminated.

\n " } }, "documentation": "\n

Detailed information about an instance group.

\n " }, "documentation": "\n

Details about the job flow's instance groups.

\n " }, "NormalizedInstanceHours": { "shape_name": "Integer", "type": "integer", "documentation": "\n

An approximation of the cost of the job flow, represented in m1.small/hours. This value is\n incremented once for every hour an m1.small runs. Larger instances are weighted more, so an\n Amazon EC2 instance that is roughly four times more expensive would result in the\n normalized instance hours being incremented by four. This result is only an approximation\n and does not reflect the actual billing rate.

\n " }, "Ec2KeyName": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job\n flow.

\n " }, "Ec2SubnetId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

\n " }, "Placement": { "shape_name": "PlacementType", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The Amazon EC2 Availability Zone for the job flow.

\n ", "required": true } }, "documentation": "\n

The Amazon EC2 Availability Zone for the job flow.

\n " }, "KeepJobFlowAliveWhenNoSteps": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the job flow should terminate after completing all steps.

\n " }, "TerminationProtected": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, \n user intervention, or in the event of a job flow error.

\n " }, "HadoopVersion": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The Hadoop version for the job flow.

\n " } }, "documentation": "\n

Describes the Amazon EC2 instances of the job flow.

\n ", "required": true }, "Steps": { "shape_name": "StepDetailList", "type": "list", "members": { "shape_name": "StepDetail", "type": "structure", "members": { "StepConfig": { "shape_name": "StepConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the job flow step.

\n ", "required": true }, "ActionOnFailure": { "shape_name": "ActionOnFailure", "type": "string", "enum": [ "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE" ], "documentation": "\n

The action to take if the job flow step fails.

\n " }, "HadoopJarStep": { "shape_name": "HadoopJarStepConfig", "type": "structure", "members": { "Properties": { "shape_name": "KeyValueList", "type": "list", "members": { "shape_name": "KeyValue", "type": "structure", "members": { "Key": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The unique identifier of a key value pair.

\n " }, "Value": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The value part of the identified key.

\n " } }, "documentation": "\n

A key value pair.

\n " }, "documentation": "\n

A list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

\n " }, "Jar": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

A path to a JAR file run during the step.

\n ", "required": true }, "MainClass": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a Main-Class in its manifest file.

\n " }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of command line arguments passed to the JAR file's main function when executed.

\n " } }, "documentation": "\n

The JAR file used for the job flow step.

\n ", "required": true } }, "documentation": "\n

The step configuration.

\n ", "required": true }, "ExecutionStatusDetail": { "shape_name": "StepExecutionStatusDetail", "type": "structure", "members": { "State": { "shape_name": "StepExecutionState", "type": "string", "enum": [ "PENDING", "RUNNING", "CONTINUE", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ], "documentation": "\n

The state of the job flow step.

\n ", "required": true }, "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the step.

\n ", "required": true }, "StartDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The start date and time of the step.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The completion date and time of the step.

\n " }, "LastStateChangeReason": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

A description of the step's current state.

\n " } }, "documentation": "\n

The description of the step status.

\n ", "required": true } }, "documentation": "\n

Combines the execution state and configuration of a step.

\n " }, "documentation": "\n

A list of steps run by the job flow.

\n " }, "BootstrapActions": { "shape_name": "BootstrapActionDetailList", "type": "list", "members": { "shape_name": "BootstrapActionDetail", "type": "structure", "members": { "BootstrapActionConfig": { "shape_name": "BootstrapActionConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the bootstrap action.

\n ", "required": true }, "ScriptBootstrapAction": { "shape_name": "ScriptBootstrapActionConfig", "type": "structure", "members": { "Path": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

Location of the script to run during a bootstrap action. Can be either a location in Amazon\n S3 or on a local file system.

\n ", "required": true }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of command line arguments to pass to the bootstrap action script.

\n " } }, "documentation": "\n

The script run by the bootstrap action.

\n ", "required": true } }, "documentation": "\n

A description of the bootstrap action.

\n " } }, "documentation": "\n

Reports the configuration of a bootstrap action in a job flow.

\n " }, "documentation": "\n

A list of the bootstrap actions run by the job flow.

\n " }, "SupportedProducts": { "shape_name": "SupportedProductsList", "type": "list", "members": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": null }, "documentation": "\n

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

\n " }, "VisibleToAllUsers": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

\n " }, "JobFlowRole": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

\n " } }, "documentation": "\n

A description of a job flow.

\n " }, "documentation": "\n

A list of job flows matching the parameters supplied.

\n " } }, "documentation": "\n

The output for the DescribeJobFlows operation.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

DescribeJobFlows returns a list of job flows that match all of the supplied parameters.\n The parameters can include a list of job flow IDs, job flow states, and restrictions on job\n flow creation date and time.

\n

Regardless of supplied parameters, only job flows created within the last two months are\n returned.

\n

If no parameters are supplied, then job flows matching either of the following criteria\n are returned:

\n \n

Amazon Elastic MapReduce can return a maximum of 512 job flow descriptions.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.DescribeJobFlows\nContent-Length: 62\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T220330Z\nX-Amz-Content-Sha256: fce83af973f96f173512aca2845c56862b946feb1de0600326f1365b658a0e39\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=29F98a6f44e05ad54fe1e8b3d1a7101ab08dc3ad348995f89c533693cee2bb3b\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-ZKIY4CKQRX72\"],\n \"DescriptionType\": \"EXTENDED\"\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 634d4142-ed9a-11e2-bbba-b56d7d016ec4\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1624\nDate: Mon, 15 Jul 2013 22:03:31 GMT\n\n{\"JobFlows\": [{\n \"AmiVersion\": \"2.3.6\",\n \"BootstrapActions\": [],\n \"ExecutionStatusDetail\": {\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923995E9,\n \"LastStateChangeReason\": \"Steps completed\",\n \"ReadyDateTime\": 1.373923754E9,\n \"StartDateTime\": 1.373923754E9,\n \"State\": \"COMPLETED\"\n },\n \"Instances\": {\n \"HadoopVersion\": \"1.0.3\",\n \"InstanceCount\": 1,\n \"InstanceGroups\": [{\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923995E9,\n \"InstanceGroupId\": \"ig-3SRUWV3E0NB7K\",\n \"InstanceRequestCount\": 1,\n \"InstanceRole\": \"MASTER\",\n \"InstanceRunningCount\": 0,\n \"InstanceType\": \"m1.small\",\n \"LastStateChangeReason\": \"Job flow terminated\",\n \"Market\": \"ON_DEMAND\",\n \"Name\": \"Master InstanceGroup\",\n \"ReadyDateTime\": 1.37392375E9,\n \"StartDateTime\": 1.373923646E9,\n \"State\": \"ENDED\"\n }],\n \"KeepJobFlowAliveWhenNoSteps\": false,\n \"MasterInstanceId\": \"i-8c4fbbef\",\n \"MasterInstanceType\": \"m1.small\",\n \"MasterPublicDnsName\": \"ec2-107-20-46-140.compute-1.amazonaws.com\",\n \"NormalizedInstanceHours\": 1,\n \"Placement\": {\"AvailabilityZone\": \"us-east-1a\"},\n \"TerminationProtected\": false\n },\n \"JobFlowId\": \"j-ZKIY4CKQRX72\",\n \"Name\": \"Development Job Flow\",\n \"Steps\": [{\n \"ExecutionStatusDetail\": {\n \"CreationDateTime\": 1.373923429E9,\n \"EndDateTime\": 1.373923914E9,\n \"StartDateTime\": 1.373923754E9,\n \"State\": \"COMPLETED\"\n },\n \"StepConfig\": {\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Args\": [\n \"-input\",\n \"s3://elasticmapreduce/samples/wordcount/input\",\n \"-output\",\n \"s3://examples-bucket/example-output\",\n \"-mapper\",\n \"s3://elasticmapreduce/samples/wordcount/wordSplitter.py\",\n \"-reducer\",\n \"aggregate\"\n ],\n \"Jar\": \"/home/hadoop/contrib/streaming/hadoop-streaming.jar\",\n \"Properties\": []\n },\n \"Name\": \"Example Streaming Step\"\n }\n }],\n \"SupportedProducts\": [],\n \"VisibleToAllUsers\": false\n}]}\n\n \n " }, "DescribeStep": { "name": "DescribeStep", "input": { "shape_name": "DescribeStepInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The identifier of the cluster with steps to describe.

\n " }, "StepId": { "shape_name": "StepId", "type": "string", "documentation": "\n

The identifier of the step to describe.

\n " } }, "documentation": "\n

This input determines which step to describe.

\n " }, "output": { "shape_name": "DescribeStepOutput", "type": "structure", "members": { "Step": { "shape_name": "Step", "type": "structure", "members": { "Id": { "shape_name": "StepId", "type": "string", "documentation": "\n

The identifier of the cluster step.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster step.

\n " }, "Config": { "shape_name": "HadoopStepConfig", "type": "structure", "members": { "Jar": { "shape_name": "String", "type": "string", "documentation": "\n

The path to the JAR file that runs during the step.

\n " }, "Properties": { "shape_name": "StringMap", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

\n " }, "MainClass": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a main class in its manifest file.

\n " }, "Args": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The list of command line arguments to pass to the JAR file's main function for execution.

\n " } }, "documentation": "\n

The Hadoop job configuration of the cluster step.\n

\n " }, "ActionOnFailure": { "shape_name": "ActionOnFailure", "type": "string", "enum": [ "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE" ], "documentation": "\n

This specifies what action to take when the cluster step fails. TERMINATE_JOB_FLOW is deprecated, use TERMINATE_CLUSTER instead.\n

\n " }, "Status": { "shape_name": "StepStatus", "type": "structure", "members": { "State": { "shape_name": "StepState", "type": "string", "enum": [ "PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ], "documentation": "\n

The execution state of the cluster step.\n

\n " }, "StateChangeReason": { "shape_name": "StepStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "StepStateChangeReasonCode", "type": "string", "enum": [ "NONE" ], "documentation": "\n

The programmable code for the state change reason.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The descriptive message for the state change reason.\n

\n " } }, "documentation": "\n

The reason for the step execution status change.\n

\n " }, "Timeline": { "shape_name": "StepTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step was created.\n

\n " }, "StartDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step execution started.\n Due to delays in step status reporting, this can display a time which pre-dates a previous call to DescribeStep that indicated the step was not yet running. \n

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step execution completed or failed. \n This can display a time that pre-dates a call to DescribeStep that indicates the step is running, due to delays in step status reporting. \n

\n " } }, "documentation": "\n

The timeline of the cluster step status over time.\n

\n " } }, "documentation": "\n

The current execution status details of the cluster step.\n

\n " } }, "documentation": "\n

The step details for the requested step identifier.

\n " } }, "documentation": "\n

This output contains the description of the cluster step.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides more detail about the cluster step.

\n " }, "ListBootstrapActions": { "name": "ListBootstrapActions", "input": { "shape_name": "ListBootstrapActionsInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The cluster identifier for the bootstrap actions to list.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Provide the pagination token from earlier API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This input determines which bootstrap actions to retrieve.

\n " }, "output": { "shape_name": "ListBootstrapActionsOutput", "type": "structure", "members": { "BootstrapActions": { "shape_name": "CommandList", "type": "list", "members": { "shape_name": "Command", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the command.

\n " }, "ScriptPath": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon S3 location of the command script.

\n " }, "Args": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Arguments for Amazon EMR to pass to the command for execution.

\n " } }, "documentation": "\n

An entity describing an executable that runs on a cluster.

\n " }, "documentation": "\n

The bootstrap actions associated with the cluster.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Use the pagination token in later API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This output contains the bootstrap actions detail.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides information about the bootstrap actions associated with a cluster.

\n \n " }, "ListClusters": { "name": "ListClusters", "input": { "shape_name": "ListClustersInput", "type": "structure", "members": { "CreatedAfter": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time beginning value filter for listing clusters.

\n " }, "CreatedBefore": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time end value filter for listing clusters.

\n " }, "ClusterStates": { "shape_name": "ClusterStateList", "type": "list", "members": { "shape_name": "ClusterState", "type": "string", "enum": [ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS" ], "documentation": null }, "documentation": "\n

The cluster state filters to apply when listing clusters.\n

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Provide the pagination token from earlier API calls to retrieve the next page of results. When the value is null, all results have been returned.\n

\n " } }, "documentation": "\n

This input determines how the ListClusters action filters the list of clusters that it returns.

\n " }, "output": { "shape_name": "ListClustersOutput", "type": "structure", "members": { "Clusters": { "shape_name": "ClusterSummaryList", "type": "list", "members": { "shape_name": "ClusterSummary", "type": "structure", "members": { "Id": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The unique identifier for the cluster.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster.

\n " }, "Status": { "shape_name": "ClusterStatus", "type": "structure", "members": { "State": { "shape_name": "ClusterState", "type": "string", "enum": [ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS" ], "documentation": "\n

The current state of the cluster.

\n " }, "StateChangeReason": { "shape_name": "ClusterStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "ClusterStateChangeReasonCode", "type": "string", "enum": [ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "USER_REQUEST", "STEP_FAILURE", "ALL_STEPS_COMPLETED" ], "documentation": "\n

The programmatic code for the state change reason.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The descriptive message for the state change reason.

\n " } }, "documentation": "\n

The reason for the cluster status change.

\n " }, "Timeline": { "shape_name": "ClusterTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the cluster.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster was ready to execute steps.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster was terminated.

\n " } }, "documentation": "\n

A timeline that represents the status of a cluster over the lifetime of the cluster.

\n " } }, "documentation": "\n

The details about the current status of the cluster.

\n " } }, "documentation": "\n

The summary description of the cluster.

\n " }, "documentation": "\n

The list of clusters for the account based on the given filters.\n

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Use the pagination token in later API calls to retrieve the next page of results. When the value is null, all results have been returned. \n

\n " } }, "documentation": "\n

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status.\n This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls. \n

\n \n " }, "ListInstanceGroups": { "name": "ListInstanceGroups", "input": { "shape_name": "ListInstanceGroupsInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The identifier of the cluster for which to list the instance groups.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Provide the pagination token from earlier API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This input determines which instance groups to retrieve.

\n " }, "output": { "shape_name": "ListInstanceGroupsOutput", "type": "structure", "members": { "InstanceGroups": { "shape_name": "InstanceGroupList", "type": "list", "members": { "shape_name": "InstanceGroup", "type": "structure", "members": { "Id": { "shape_name": "InstanceGroupId", "type": "string", "documentation": "\n

The identifier of the instance group.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the instance group.

\n " }, "Market": { "shape_name": "MarketType", "type": "string", "enum": [ "ON_DEMAND", "SPOT" ], "documentation": "\n

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

\n " }, "InstanceGroupType": { "shape_name": "InstanceGroupType", "type": "string", "enum": [ "MASTER", "CORE", "TASK" ], "documentation": "\n

The type of the instance group. Valid values are MASTER, CORE or TASK.

\n " }, "BidPrice": { "shape_name": "String", "type": "string", "documentation": "\n

The bid price for each EC2 instance in the\n instance group when launching nodes as Spot Instances, expressed in USD.

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The EC2 instance type for all instances in the instance group.

\n " }, "RequestedInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The target number of instances for the instance group.

\n " }, "RunningInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of instances currently running in this instance group.

\n " }, "Status": { "shape_name": "InstanceGroupStatus", "type": "structure", "members": { "State": { "shape_name": "InstanceGroupState", "type": "string", "enum": [ "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED", "ARRESTED", "SHUTTING_DOWN", "ENDED" ], "documentation": "\n

The current state of the instance group. The following values are deprecated: ARRESTED, SHUTTING_DOWN, and ENDED. Use SUSPENDED, TERMINATING, and TERMINATED instead, respectively.\n

\n " }, "StateChangeReason": { "shape_name": "InstanceGroupStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "InstanceGroupStateChangeReasonCode", "type": "string", "enum": [ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "CLUSTER_TERMINATED" ], "documentation": "\n

The programmable code for the state change reason.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The status change reason description.

\n " } }, "documentation": "\n

The status change reason details for the instance group.

\n " }, "Timeline": { "shape_name": "InstanceGroupTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the instance group.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the instance group became ready to perform tasks.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the instance group terminated.

\n " } }, "documentation": "\n

The timeline of the instance group status over time.

\n " } }, "documentation": "\n

The current status of the instance group.

\n " } }, "documentation": "\n

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

\n " }, "documentation": "\n

The list of instance groups for the cluster and given filters.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Use the pagination token in later API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This input determines which instance groups to retrieve.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides all available details about the instance groups in a cluster.

\n \n " }, "ListInstances": { "name": "ListInstances", "input": { "shape_name": "ListInstancesInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The identifier of the cluster for which to list the instances.

\n " }, "InstanceGroupId": { "shape_name": "InstanceGroupId", "type": "string", "documentation": "\n

The identifier of the instance group for which to list the instances.

\n " }, "InstanceGroupTypes": { "shape_name": "InstanceGroupTypeList", "type": "list", "members": { "shape_name": "InstanceGroupType", "type": "string", "enum": [ "MASTER", "CORE", "TASK" ], "documentation": null }, "documentation": "\n

The type of instance group for which to list the instances.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Provide the pagination token from earlier API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This input determines which instances to list.

\n " }, "output": { "shape_name": "ListInstancesOutput", "type": "structure", "members": { "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "Id": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

The unique identifier for the instance in Amazon EMR.

\n " }, "Ec2InstanceId": { "shape_name": "InstanceId", "type": "string", "documentation": "\n

The unique identifier of the instance in Amazon EC2.

\n " }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

The public DNS name of the instance.

\n " }, "PublicIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of the instance.

\n " }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n

The private DNS name of the instance.

\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of the instance.

\n " }, "Status": { "shape_name": "InstanceStatus", "type": "structure", "members": { "State": { "shape_name": "InstanceState", "type": "string", "enum": [ "AWAITING_FULFILLMENT", "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "TERMINATED" ], "documentation": "\n

The current state of the instance.

\n " }, "StateChangeReason": { "shape_name": "InstanceStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "InstanceStateChangeReasonCode", "type": "string", "enum": [ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "CLUSTER_TERMINATED" ], "documentation": "\n

The programmable code for the state change reason.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The status change reason description.

\n " } }, "documentation": "\n

The details of the status change reason for the instance.

\n " }, "Timeline": { "shape_name": "InstanceTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The creation date and time of the instance.

\n " }, "ReadyDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the instance was ready to perform tasks.

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the instance was terminated.

\n " } }, "documentation": "\n

The timeline of the instance status over time.

\n " } }, "documentation": "\n

The current status of the instance.

\n " } }, "documentation": "\n

Represents an EC2 instance provisioned as part of cluster.

\n " }, "documentation": "\n

The list of instances for the cluster and given filters.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Use the pagination token in later API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This output contains the list of instances.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. \n For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.\n

\n " }, "ListSteps": { "name": "ListSteps", "input": { "shape_name": "ListStepsInput", "type": "structure", "members": { "ClusterId": { "shape_name": "ClusterId", "type": "string", "documentation": "\n

The identifier of the cluster for which to list the steps.

\n " }, "StepStates": { "shape_name": "StepStateList", "type": "list", "members": { "shape_name": "StepState", "type": "string", "enum": [ "PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ], "documentation": null }, "documentation": "\n

The filter to limit the step list based on certain states.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Provide the pagination token from earlier API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This input determines which steps to list.

\n " }, "output": { "shape_name": "ListStepsOutput", "type": "structure", "members": { "Steps": { "shape_name": "StepSummaryList", "type": "list", "members": { "shape_name": "StepSummary", "type": "structure", "members": { "Id": { "shape_name": "StepId", "type": "string", "documentation": "\n

The identifier of the cluster step.\n

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster step.\n

\n " }, "Status": { "shape_name": "StepStatus", "type": "structure", "members": { "State": { "shape_name": "StepState", "type": "string", "enum": [ "PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ], "documentation": "\n

The execution state of the cluster step.\n

\n " }, "StateChangeReason": { "shape_name": "StepStateChangeReason", "type": "structure", "members": { "Code": { "shape_name": "StepStateChangeReasonCode", "type": "string", "enum": [ "NONE" ], "documentation": "\n

The programmable code for the state change reason.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

The descriptive message for the state change reason.\n

\n " } }, "documentation": "\n

The reason for the step execution status change.\n

\n " }, "Timeline": { "shape_name": "StepTimeline", "type": "structure", "members": { "CreationDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step was created.\n

\n " }, "StartDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step execution started.\n Due to delays in step status reporting, this can display a time which pre-dates a previous call to DescribeStep that indicated the step was not yet running. \n

\n " }, "EndDateTime": { "shape_name": "Date", "type": "timestamp", "documentation": "\n

The date and time when the cluster step execution completed or failed. \n This can display a time that pre-dates a call to DescribeStep that indicates the step is running, due to delays in step status reporting. \n

\n " } }, "documentation": "\n

The timeline of the cluster step status over time.\n

\n " } }, "documentation": "\n

The current execution status details of the cluster step.\n

\n " } }, "documentation": "\n

The summary of the cluster step.

\n " }, "documentation": "\n

The filtered list of steps for the cluster.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n

The pagination token is a random string indicating whether there are more results to fetch. Use the pagination token in later API calls to retrieve the next page of results. When the value is null, all results have been returned.

\n " } }, "documentation": "\n

This output contains the list of steps.

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Provides a list of steps for the cluster. \n

\n " }, "ModifyInstanceGroups": { "name": "ModifyInstanceGroups", "input": { "shape_name": "ModifyInstanceGroupsInput", "type": "structure", "members": { "InstanceGroups": { "shape_name": "InstanceGroupModifyConfigList", "type": "list", "members": { "shape_name": "InstanceGroupModifyConfig", "type": "structure", "members": { "InstanceGroupId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Unique ID of the instance group to expand or shrink.

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

Target size for the instance group.

\n " }, "EC2InstanceIdsToTerminate": { "shape_name": "EC2InstanceIdsToTerminateList", "type": "list", "members": { "shape_name": "InstanceId", "type": "string", "documentation": null }, "documentation": "\n

The EC2 InstanceIds to terminate. For advanced users only. \n Once you terminate the instances, the instance group will not return to its original requested size.

\n " } }, "documentation": "\n

Modify an instance group size.

\n " }, "documentation": "\n

Instance groups to change.

\n " } }, "documentation": "\n

Change the size of some instance groups.

\n " }, "output": null, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance\n group. The input parameters include the new target instance count for the group and the\n instance group ID. The call will either succeed or fail atomically.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.ModifyInstanceGroups\nContent-Length: 77\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T205843Z\nX-Amz-Content-Sha256: bb1af3d0c6c6a1a09f21ccd7f04a0e2e6c9ce5b5810b0f6777560fe4f81bda8c\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=17bbbb4448a1f47a14d5657445e9de5cadf16bed58b850585f80865882133b33\nAccept: */*\n\n{\"InstanceGroups\": [{\n \"InstanceGroupId\": \"ig-1S8NWT31S2OVG\",\n \"InstanceCount\": 5\n}]}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 80a74808-ee5a-11e2-90db-69a5154aeb8d\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 20:58:44 GMT\n\n \n \n \n " }, "RemoveTags": { "name": "RemoveTags", "input": { "shape_name": "RemoveTagsInput", "type": "structure", "members": { "ResourceId": { "shape_name": "ResourceId", "type": "string", "documentation": "\n

The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.

\n " }, "TagKeys": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of tag keys to remove from a resource.

\n " } }, "documentation": "\n

This input identifies a cluster and a list of tags to remove. \n

\n " }, "output": { "shape_name": "RemoveTagsOutput", "type": "structure", "members": {}, "documentation": "\n

This output indicates the result of removing tags from a resource. \n

\n " }, "errors": [ { "shape_name": "InternalServerException", "type": "structure", "members": { "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is an internal failure in the EMR service.

\n \n " }, { "shape_name": "InvalidRequestException", "type": "structure", "members": { "ErrorCode": { "shape_name": "ErrorCode", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The error code associated with the exception.

\n \n " }, "Message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

The message associated with the exception.

\n \n " } }, "documentation": "\n

This exception occurs when there is something wrong with user input.

\n \n " } ], "documentation": "\n

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n \n " }, "RunJobFlow": { "name": "RunJobFlow", "input": { "shape_name": "RunJobFlowInput", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the job flow.

\n ", "required": true }, "LogUri": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The location in Amazon S3 to write the log files of the job flow. If a value is\n not provided, logs are not created.

\n " }, "AdditionalInfo": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

A JSON string for selecting additional features.

\n " }, "AmiVersion": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

\n \n \n

If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20) you can use the \n JobFlowInstancesConfig HadoopVersion parameter\n to modify the version of Hadoop from the defaults shown above.

\n

For details about the AMI versions currently \n supported by Amazon Elastic MapReduce, go to AMI Versions Supported in Elastic MapReduce in the \n Amazon Elastic MapReduce Developer's Guide.\n

\n " }, "Instances": { "shape_name": "JobFlowInstancesConfig", "type": "structure", "members": { "MasterInstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The EC2 instance type of the master node.

\n " }, "SlaveInstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The EC2 instance type of the slave nodes.

\n " }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of Amazon EC2 instances used to execute the job flow.

\n " }, "InstanceGroups": { "shape_name": "InstanceGroupConfigList", "type": "list", "members": { "shape_name": "InstanceGroupConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Friendly name given to the instance group.

\n " }, "Market": { "shape_name": "MarketType", "type": "string", "enum": [ "ON_DEMAND", "SPOT" ], "documentation": "\n

Market type of the Amazon EC2 instances used to create a cluster node.

\n " }, "InstanceRole": { "shape_name": "InstanceRoleType", "type": "string", "enum": [ "MASTER", "CORE", "TASK" ], "documentation": "\n

The role of the instance group in the cluster.

\n ", "required": true }, "BidPrice": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

Bid price for each Amazon EC2 instance in the\n instance group when launching nodes as Spot Instances, expressed in USD.

\n " }, "InstanceType": { "shape_name": "InstanceType", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 256, "documentation": "\n

The Amazon EC2 instance type for all instances in the instance group.

\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

Target number of instances for the instance group.

\n ", "required": true } }, "documentation": "\n

Configuration defining a new instance group.

\n " }, "documentation": "\n

Configuration for the job flow's instance groups.

\n " }, "Ec2KeyName": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the Amazon EC2 key pair that can be used to ssh to the master node as\n the user called \"hadoop.\"

\n " }, "Placement": { "shape_name": "PlacementType", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The Amazon EC2 Availability Zone for the job flow.

\n ", "required": true } }, "documentation": "\n

The Availability Zone the job flow will run in.

\n " }, "KeepJobFlowAliveWhenNoSteps": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether the job flow should terminate after completing all steps.

\n " }, "TerminationProtected": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, \n user intervention, or in the event of a job flow error.

\n " }, "HadoopVersion": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The Hadoop version for the job flow. Valid inputs are \"0.18\", \"0.20\", or \"0.20.205\". If you do not set this value, the default of 0.18 is used, \n unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

\n " }, "Ec2SubnetId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

\n To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where \n you want the job flow to launch. If you do not specify this value, the job flow is launched in the normal Amazon Web Services cloud, outside of an \n Amazon VPC. \n

\n

\n Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. \n Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.\n

\n " } }, "documentation": "\n

A specification of the number and type of Amazon EC2 instances on which to run the job\n flow.

\n ", "required": true }, "Steps": { "shape_name": "StepConfigList", "type": "list", "members": { "shape_name": "StepConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the job flow step.

\n ", "required": true }, "ActionOnFailure": { "shape_name": "ActionOnFailure", "type": "string", "enum": [ "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE" ], "documentation": "\n

The action to take if the job flow step fails.

\n " }, "HadoopJarStep": { "shape_name": "HadoopJarStepConfig", "type": "structure", "members": { "Properties": { "shape_name": "KeyValueList", "type": "list", "members": { "shape_name": "KeyValue", "type": "structure", "members": { "Key": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The unique identifier of a key value pair.

\n " }, "Value": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The value part of the identified key.

\n " } }, "documentation": "\n

A key value pair.

\n " }, "documentation": "\n

A list of Java properties that are set when the step runs. You can use these properties to\n pass key value pairs to your main function.

\n " }, "Jar": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

A path to a JAR file run during the step.

\n ", "required": true }, "MainClass": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

The name of the main class in the specified Java file. If not specified, the JAR file\n should specify a Main-Class in its manifest file.

\n " }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of command line arguments passed to the JAR file's main function when executed.

\n " } }, "documentation": "\n

The JAR file used for the job flow step.

\n ", "required": true } }, "documentation": "\n

Specification of a job flow step.

\n " }, "documentation": "\n

A list of steps to be executed by the job flow.

\n " }, "BootstrapActions": { "shape_name": "BootstrapActionConfigList", "type": "list", "members": { "shape_name": "BootstrapActionConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the bootstrap action.

\n ", "required": true }, "ScriptBootstrapAction": { "shape_name": "ScriptBootstrapActionConfig", "type": "structure", "members": { "Path": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

Location of the script to run during a bootstrap action. Can be either a location in Amazon\n S3 or on a local file system.

\n ", "required": true }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of command line arguments to pass to the bootstrap action script.

\n " } }, "documentation": "\n

The script run by the bootstrap action.

\n ", "required": true } }, "documentation": "\n

Configuration of a bootstrap action.

\n " }, "documentation": "\n

A list of bootstrap actions that will be run before Hadoop is started on the cluster\n nodes.

\n " }, "SupportedProducts": { "shape_name": "SupportedProductsList", "type": "list", "members": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": null }, "documentation": "\n

A list of strings that indicates third-party software to use with the job flow. For more information, go to Use Third Party Applications with Amazon EMR. Currently supported values are:

\n \n " }, "NewSupportedProducts": { "shape_name": "NewSupportedProductsList", "type": "list", "members": { "shape_name": "SupportedProductConfig", "type": "structure", "members": { "Name": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

The name of the product configuration.

\n " }, "Args": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

The list of user-supplied arguments.

\n " } }, "documentation": "\n

The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

\n " }, "documentation": "\n

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation\n script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

\n \n " }, "VisibleToAllUsers": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the job flow. If it is set to false, only the IAM user that created the job flow can view and manage it.

\n " }, "JobFlowRole": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": "\n

An IAM role for the job flow. The EC2 instances of the job flow assume this role. The default role is EMRJobflowDefault. In order to use the default role, you must have already created it using the CLI.

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined key, which is the minimum required information for a valid tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined value, which is optional in a tag.\n For more information, see Tagging Amazon EMR Resources. \n

\n " } }, "documentation": "\n

A key/value pair that contains user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. \n For more information, see Tagging Amazon EMR Resources. \n

\n " }, "documentation": "\n

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

\n " } }, "documentation": "\n

Input to the RunJobFlow operation.

\n " }, "output": { "shape_name": "RunJobFlowOutput", "type": "structure", "members": { "JobFlowId": { "shape_name": "XmlStringMaxLen256", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 256, "documentation": "\n

An unique identifier for the job flow.

\n " } }, "documentation": "\n

The result of the RunJobFlow operation.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

RunJobFlow creates and starts running a new job flow. The job flow will run the steps\n specified. Once the job flow completes, the cluster is stopped and the HDFS partition is\n lost. To prevent loss of data, configure the last step of the job flow to store results in\n Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is\n set to TRUE, the job flow will transition to the WAITING state rather than\n shutting down once the steps have completed.

\n \n

For additional protection, you can set the \n JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the \n job flow and prevent it from being \n terminated by API call, user intervention, or in the event of a job flow error.

\n\n

A maximum of 256 steps are allowed in each job flow.

\n \n

If your job flow is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, go to Add More than 256 Steps to a Job Flow in the Amazon Elastic MapReduce Developer's Guide.

\n\n

For long running job flows, we recommend that you periodically store your results.

\n\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.RunJobFlow\nContent-Length: 734\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T210803Z\nX-Amz-Content-Sha256: 8676d21986e4628a89fb1232a1344063778d4ffc23d10be02b437e0d53a24db3\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=71f79725c4dbe77c0e842718485f0b37fe6df69e1153c80f7748ebd9617ca2f3\nAccept: */*\n\n\n{\n \"Name\": \"Development Job Flow\",\n \"Instances\": {\n \"KeepJobFlowAliveWhenNoSteps\": \"false\",\n \"TerminationProtected\": \"false\",\n \"InstanceGroups\": [{\n \"Name\": \"Master Instance Group\",\n \"InstanceRole\": \"MASTER\",\n \"InstanceCount\": 1,\n \"InstanceType\": \"m1.small\",\n \"Market\": \"ON_DEMAND\"\n }]\n },\n \"Steps\": [{\n \"Name\": \"Example Streaming Step\",\n \"ActionOnFailure\": \"CANCEL_AND_WAIT\",\n \"HadoopJarStep\": {\n \"Jar\": \"/home/hadoop/contrib/streaming/hadoop-streaming.jar\",\n \"Args\": [\n \"-input\",\n \"s3://elasticmapreduce/samples/wordcount/input\",\n \"-output\",\n \"s3://examples-bucket/example-output\",\n \"-mapper\",\n \"s3://elasticmapreduce/samples/wordcount/wordSplitter.py\",\n \"-reducer\",\n \"aggregate\"\n ]\n }\n }],\n \"BootstrapActions\": [],\n \"VisibleToAllUsers\": \"false\",\n \"NewSupportedProducts\": [],\n \"AmiVersion\": \"latest\"\n}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: a4406d6b-ed92-11e2-9787-192218ecb460\nContent-Type: application/x-amz-json-1.1\nContent-Length: 31\nDate: Mon, 15 Jul 2013 21:08:05 GMT\n\n{\"JobFlowId\": \"j-ZKIY4CKQRX72\"}\n \n \n " }, "SetTerminationProtection": { "name": "SetTerminationProtection", "input": { "shape_name": "SetTerminationProtectionInput", "type": "structure", "members": { "JobFlowIds": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of strings that uniquely identify the job flows to protect. This identifier is returned by\n RunJobFlow and can also be obtained from DescribeJobFlows .

\n ", "required": true }, "TerminationProtected": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean that indicates whether to protect the job flow and \n prevent the Amazon EC2 instances in the cluster from shutting down due to \n API calls, user intervention, or job-flow error.

\n ", "required": true } }, "documentation": "\n

The input argument to the TerminationProtection operation.

\n " }, "output": null, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

SetTerminationProtection locks a job flow so the Amazon EC2 instances in the cluster \n cannot be terminated by user intervention, an API call, or in the event of a job-flow error. \n The cluster still terminates upon successful completion of the job flow. Calling \n SetTerminationProtection on a job flow is analogous to calling the \n Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

\n \n

SetTerminationProtection is used to prevent accidental termination of a job flow and to \n ensure that in the event of an error, the instances will persist so you can recover \n any data stored in their ephemeral instance storage.

\n \n

To terminate a job flow that has been locked by setting SetTerminationProtection to true, \n you must first unlock the job flow by a subsequent call to SetTerminationProtection \n in which you set the value to false.

\n \n

For more information, go to Protecting a Job Flow from Termination in the \n Amazon Elastic MapReduce Developer's Guide.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.SetTerminationProtection\nContent-Length: 61\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T211420Z\nX-Amz-Content-Sha256: c362fadae0fce377aa63f04388aeb90c53cedb17a8bfbb8cffcb10c2378137f9\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=764b6aa1a38733cadff35a2e884887e9f1208a422266bc83ac77e8d0b80bd4cf\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-3TS0OIYO4NFN\"],\n \"TerminationProtected\": true\n}\n\n \n HTTP/1.1 200 OK\nx-amzn-RequestId: af23b1db-ee5c-11e2-9787-192218ecb460\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:14:21 GMT\n\n \n \n " }, "SetVisibleToAllUsers": { "name": "SetVisibleToAllUsers", "input": { "shape_name": "SetVisibleToAllUsersInput", "type": "structure", "members": { "JobFlowIds": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

Identifiers of the job flows to receive the new visibility setting.

\n ", "required": true }, "VisibleToAllUsers": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the specified job flows are visible to all IAM users of the AWS account associated with the job flow. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the job flows. If it is set to False, only the IAM user that created a job flow can view and manage it.

\n ", "required": true } }, "documentation": "\n

The input to the SetVisibleToAllUsers action.

\n " }, "output": null, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified job flows. This action works on running job flows. You can also set the visibility of \n a job flow when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the job flow or the AWS account that owns the job flow.

\n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.SetVisibleToAllUsers\nContent-Length: 58\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130715T221616Z\nX-Amz-Content-Sha256: 2ff32d11eab2383d764ffcb97571454e798689ecd09a7b1bb2327e22b0b930d4\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=e1a00b37787d9ccc43c9de32f1f0a73813b0bd6643d4db7762b62a7092d51997\nAccept: */*\n\n{\n \"JobFlowIds\": [\"j-ZKIY4CKQRX72\"],\n \"VisibleToAllUsers\": true\n}\n\n\n \n HTTP/1.1 200 OK\nx-amzn-RequestId: 2be9cde9-ed9c-11e2-82b6-2351cde3f33f\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 15 Jul 2013 22:16:18 GMT\n\n\n \n \n " }, "TerminateJobFlows": { "name": "TerminateJobFlows", "input": { "shape_name": "TerminateJobFlowsInput", "type": "structure", "members": { "JobFlowIds": { "shape_name": "XmlStringList", "type": "list", "members": { "shape_name": "XmlString", "type": "string", "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, "documentation": null }, "documentation": "\n

A list of job flows to be shutdown.

\n ", "required": true } }, "documentation": "\n

Input to the TerminateJobFlows operation.

\n " }, "output": null, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": {}, "documentation": "\n

Indicates that an error occurred while processing the request and that the request was not\n completed.

\n " } ], "documentation": "\n

\n TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step\n not yet completed is canceled and the EC2 instances on which the job flow is running are\n stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was\n specified when the job flow was created. \n

\n

\n The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, \n it may take up to 5-20 minutes for the job flow to \n completely terminate and release allocated resources, such as Amazon EC2 instances.\n

\n \n \n POST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: ElasticMapReduce.TerminateJobFlows\nContent-Length: 33\nUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32\nHost: us-east-1.elasticmapreduce.amazonaws.com\nX-Amz-Date: 20130716T211858Z\nX-Amz-Content-Sha256: ab64713f61e066e80a6083844b9249b6c6362d34a7ae7393047aa46d38b9e315\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=9791416eaf09f36aa753a324b0de27ff5cc7084b8548cc748487a2bcb3439d58\nAccept: */*\n\n{\"JobFlowIds\": [\"j-3TS0OIYO4NFN\"]}\n\n\n HTTP/1.1 200 OK\nx-amzn-RequestId: 5551a7c9-ee5d-11e2-9542-25296c300ff0\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Tue, 16 Jul 2013 21:18:59 GMT\n \n \n " } }, "xmlnamespace": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31", "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": "http://ap-northeast-1.elasticmapreduce.amazonaws.com/", "sa-east-1": "http://sa-east-1.elasticmapreduce.amazonaws.com/", "ap-southeast-1": "http://ap-southeast-1.elasticmapreduce.amazonaws.com/", "ap-southeast-2": "http://ap-southeast-2.elasticmapreduce.amazonaws.com/", "us-west-2": "http://us-west-2.elasticmapreduce.amazonaws.com/", "us-west-1": "http://us-west-1.elasticmapreduce.amazonaws.com/", "eu-west-1": "http://eu-west-1.elasticmapreduce.amazonaws.com/", "us-gov-west-1": null, "cn-north-1": "https://elasticmapreduce.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/iam.json0000644000175000017500000164371112254746566017726 0ustar takakitakaki{ "api_version": "2010-05-08", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "AWS Identity and Access Management", "service_abbreviation": "IAM", "global_endpoint": "iam.amazonaws.com", "endpoint_prefix": "iam", "xmlnamespace": "https://iam.amazonaws.com/doc/2010-05-08/", "documentation": "\n\t\tAWS Identity and Access Management\n\t\t\n\t\t

AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions\n\t\t\tunder your AWS account. This guide provides descriptions of the IAM API. For general\n\t\t\tinformation about IAM, see AWS Identity\n\t\t\t\tand Access Management (IAM). For the user guide for IAM, see Using IAM.

\n\t\t\n\t\t AWS provides SDKs that consist of libraries and sample code for various programming\n\t\t\tlanguages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient\n\t\t\tway to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks\n\t\t\tsuch as cryptographically signing requests (see below), managing errors, and retrying requests\n\t\t\tautomatically. For information about the AWS SDKs, including how to download and install them,\n\t\t\tsee the Tools for Amazon Web Services page. \n\t\t\n\t\t

Using the IAM Query API, you make direct calls to the IAM web service. IAM supports\n\t\t\tGET and POST requests for all actions. That is, the API does not require you to use GET for\n\t\t\tsome actions and POST for others. However, GET requests are subject to the limitation size of\n\t\t\ta URL; although this limit is browser dependent, a typical limit is 2048 bytes. Therefore, for\n\t\t\toperations that require larger sizes, you must use a POST request.

\n\t\t\n\t\t

Signing Requests
Requests must be signed using an access key ID and a secret\n\t\t\taccess key. We strongly recommend that you do not use your AWS account access key ID and\n\t\t\tsecret access key for everyday work with IAM. You can use the access key ID and secret access\n\t\t\tkey for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials\n\t\t\tand use those to sign requests.

\n\t\t\n\t\t

To sign requests, we recommend that you use Signature Version 4. If\n\t\t\tyou have an existing application that uses Signature Version 2, you do not have to update it\n\t\t\tto use Signature Version 4. However, some operations now require Signature Version 4. The\n\t\t\tdocumentation for operations that require version 4 indicate this requirement.

\n\t\t\n\n\t\t

Additional Resources
\n\t\tFor more information, see the following:

\n\t\t\n\t\t\n\t", "operations": { "AddRoleToInstanceProfile": { "name": "AddRoleToInstanceProfile", "input": { "shape_name": "AddRoleToInstanceProfileRequest", "type": "structure", "members": { "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the instance profile to update.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to add.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Adds the specified role to the specified instance profile. For more information about roles,\n\t\t\tgo to Working with\n\t\t\t\tRoles. For more information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=AddRoleToInstanceProfile\n&InstanceProfileName=Webserver\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t \n\t\t\t\n\n \n 12657608-99f2-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "AddUserToGroup": { "name": "AddUserToGroup", "input": { "shape_name": "AddUserToGroupRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to update.

\n\t", "required": true }, "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to add.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Adds the specified user to the specified group.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=AddUserToGroup\n&GroupName=Managers\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "ChangePassword": { "name": "ChangePassword", "input": { "shape_name": "ChangePasswordRequest", "type": "structure", "members": { "OldPassword": { "shape_name": "passwordType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, "documentation": null, "required": true }, "NewPassword": { "shape_name": "passwordType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, "documentation": null, "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "InvalidUserTypeException", "type": "structure", "members": { "message": { "shape_name": "invalidUserTypeMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the type of user for the transaction was incorrect.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" } ], "documentation": "\n\t\t

Changes the password of the IAM user calling ChangePassword. The root account\n\t\t\tpassword is not affected by this action. For information about modifying passwords, see Managing Passwords.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ChangePassword\n&OldPassword=U79}kgds4?\n&NewPassword=Lb0*1(9xpN\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "CreateAccessKey": { "name": "CreateAccessKey", "input": { "shape_name": "CreateAccessKeyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The user name that the new key will belong to.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "CreateAccessKeyResponse", "type": "structure", "members": { "AccessKey": { "shape_name": "AccessKey", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the key is associated with.

\n\t", "required": true }, "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The ID for this access key.

\n\t", "required": true }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status of the access key. Active means the key is valid for API calls, while\n\t\t\t\tInactive means it is not.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "sensitive": true, "documentation": "\n\t\t

The secret key used to sign requests.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the access key was created.

\n\t" } }, "documentation": "\n\t\t

Information about the access key.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateAccessKey action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Creates a new AWS secret access key and corresponding AWS access key ID for the specified\n\t\t\tuser. The default status for new keys is Active.

\n\t\t

If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.

\n\t\t

For information about limits on the number of keys you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tTo ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation. You must save the key (for example, in a text file) if you want\n\t\t\tto be able to access it again. If a secret key is lost, you can delete the access keys for the\n\t\t\tassociated user and then create new keys.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateAccessKey\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n Bob\n AKIAIOSFODNN7EXAMPLE\n Active\n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "CreateAccountAlias": { "name": "CreateAccountAlias", "input": { "shape_name": "CreateAccountAliasRequest", "type": "structure", "members": { "AccountAlias": { "shape_name": "accountAliasType", "type": "string", "min_length": 3, "max_length": 63, "pattern": "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$", "documentation": "\n\t\t

Name of the account alias to create.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

This action creates an alias for your AWS account. For information about using an AWS account\n\t\t\talias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 36b5db08-f1b0-11df-8fbe-45274EXAMPLE\n \n\n \n\t\t\n\t" }, "CreateGroup": { "name": "CreateGroup", "input": { "shape_name": "CreateGroupRequest", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" }, "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to create. Do not include the path in this value.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "CreateGroupResponse", "type": "structure", "members": { "Group": { "shape_name": "Group", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the group.

\n\t", "required": true }, "GroupId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the group was created.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the group.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateGroup action.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Creates a new group.

\n\t\t

For information about the number of groups you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateGroup\n&Path=/\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /\n Admins\n AGPACKCEVSQ6C2EXAMPLE\n arn:aws:iam::123456789012:group/Admins\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "CreateInstanceProfile": { "name": "CreateInstanceProfile", "input": { "shape_name": "CreateInstanceProfileRequest", "type": "structure", "members": { "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the instance profile to create.

\n\t", "required": true }, "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" } }, "documentation": " " }, "output": { "shape_name": "CreateInstanceProfileResponse", "type": "structure", "members": { "InstanceProfile": { "shape_name": "InstanceProfile", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the instance profile.

\n\t", "required": true }, "InstanceProfileId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the instance profile was created.

\n\t", "required": true }, "Roles": { "shape_name": "roleListType", "type": "list", "members": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

The Role data type contains information about a role.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

The role associated with the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateInstanceProfile\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Creates a new instance profile. For information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t

For information about the number of instance profiles you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateInstanceProfile\n&InstanceProfileName=Webserver\n&Path=/application_abc/component_xyz/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n AIPAD5ARO2C5EXAMPLE3G\n \n Webserver\n /application_abc/component_xyz/\n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver\n 2012-05-09T16:11:10.222Z\n \n \n \n 974142ee-99f1-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "CreateLoginProfile": { "name": "CreateLoginProfile", "input": { "shape_name": "CreateLoginProfileRequest", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to create a password for.

\n\t", "required": true }, "Password": { "shape_name": "passwordType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, "documentation": "\n\t\t

The new password for the user name.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "CreateLoginProfileResponse", "type": "structure", "members": { "LoginProfile": { "shape_name": "LoginProfile", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the user, which can be used for signing into the AWS Management Console.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the password for the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The user name and password create date.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateLoginProfile action.

\n\t" }, "errors": [ { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "PasswordPolicyViolationException", "type": "structure", "members": { "message": { "shape_name": "passwordPolicyViolationMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the provided password did not meet the requirements imposed\n\t\t\tby the account password policy.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Creates a password for the specified user, giving the user the ability to access AWS services\n\t\t\tthrough the AWS Management Console. For more information about managing passwords, see Managing Passwords in Using IAM.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateLoginProfile\n&UserName=Bob\n&Password=Password1\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n Bob\n 2011-09-19T23:00:56Z\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "CreateRole": { "name": "CreateRole", "input": { "shape_name": "CreateRoleRequest", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to create.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "CreateRoleResponse", "type": "structure", "members": { "Role": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

Information about the role.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateRole action.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" } ], "documentation": "\n\t\t

Creates a new role for your AWS account. For more information about roles, go to Working with Roles.\n\t\t\tFor information about limitations on role names and the number of roles you can create, go to\n\t\t\t\tLimitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

The policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded\n\t\t\taccording to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.\n\t\t\tCurrently, only EC2 instances can assume roles.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateRole\n&RoleName=S3Access\n&Path=/application_abc/component_xyz/\n&AssumeRolePolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t\n\t\t\t\n\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-08T23:34:01.495Z\n AROADBQP57FF2AEXAMPLE\n \n \n \n 4a93ceee-9966-11e1-b624-b1aEXAMPLE7c\n \n\n \n\t\t\n\t" }, "CreateSAMLProvider": { "name": "CreateSAMLProvider", "input": { "shape_name": "CreateSAMLProviderRequest", "type": "structure", "members": { "SAMLMetadataDocument": { "shape_name": "SAMLMetadataDocumentType", "type": "string", "min_length": 1000, "max_length": 10000000, "documentation": "\n\t\t

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP.

\n\t\t\n\t\t

For more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tSecurity Credentials guide.

\n\t\t\n\t", "required": true }, "Name": { "shape_name": "SAMLProviderNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w._-]*", "documentation": "\n\t\t

The name of the provider to create.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "CreateSAMLProviderResponse", "type": "structure", "members": { "SAMLProviderArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateSAMLProvider action.

\n\t" }, "errors": [ { "shape_name": "InvalidInputException", "type": "structure", "members": { "message": { "shape_name": "invalidInputMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.

\n\t\t

The SAML provider that you create with this operation can be used as a principal in a role's\n\t\t\ttrust policy to establish a trust relationship between AWS and a SAML identity provider. You\n\t\t\tcan create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one\n\t\t\tthat supports API access to AWS.

\n\t\t\n\t\t

When you create the SAML provider, you upload an a SAML metadata document that you get from\n\t\t\tyour IdP and that includes the issuer's name, expiration information, and keys that can be\n\t\t\tused to validate the SAML authentication response (assertions) that are received from the IdP.\n\t\t\tYou must generate the metadata document using the identity management software that is used as\n\t\t\tyour organization's IdP.

\n\t\t\n\t\tThis operation requires Signature Version\n\t\t\t4.\n\t\t\n\t\t

For more information, see Giving Console Access Using SAML and Creating\n\t\t\t\tTemporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tCredentials guide.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateSAMLProvider\n&Name=MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n arn:aws:iam::123456789012:saml-metadata/MyUniversity\n \n \n 29f47818-99f5-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "CreateUser": { "name": "CreateUser", "input": { "shape_name": "CreateUserRequest", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path for the user name. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to create.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "CreateUserResponse", "type": "structure", "members": { "User": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the user.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateUser action.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Creates a new user for your AWS account.

\n\t\t

For information about limitations on the number of users you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateUser\n&Path=/division_abc/subdivision_xyz/\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n\t\t\t\n\t\t\t\n\n \n \n /division_abc/subdivision_xyz/\n Bob\n AIDACKCEVSQ6C2EXAMPLE\n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "CreateVirtualMFADevice": { "name": "CreateVirtualMFADevice", "input": { "shape_name": "CreateVirtualMFADeviceRequest", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" }, "VirtualMFADeviceName": { "shape_name": "virtualMFADeviceName", "type": "string", "pattern": "[\\w+=,.@-]*", "min_length": 1, "documentation": "\n\t\t

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA\n\t\t\tdevice.

\n\t", "required": true } }, "documentation": null }, "output": { "shape_name": "CreateVirtualMFADeviceResponse", "type": "structure", "members": { "VirtualMFADevice": { "shape_name": "VirtualMFADevice", "type": "structure", "members": { "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number associated with VirtualMFADevice.

\n\t", "required": true }, "Base32StringSeed": { "shape_name": "BootstrapDatum", "type": "blob", "sensitive": true, "documentation": "\n\t\t

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

\n\t" }, "QRCodePNG": { "shape_name": "BootstrapDatum", "type": "blob", "sensitive": true, "documentation": "\n\t\t

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?\n\t\t\t\tsecret=$Base32String where $virtualMFADeviceName is one of the create call arguments,\n\t\t\tAccountName is the user name if set (accountId otherwise), and Base32String is the seed in\n\t\t\tBase32 format. The Base32String is Base64-encoded.

\n\t" }, "User": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The User data type contains information about a user.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "EnableDate": { "shape_name": "dateType", "type": "timestamp", "documentation": null } }, "documentation": "\n\t\t

A newly created virtual MFA device.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the CreateVirtualMFADevice\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" } ], "documentation": "\n\t\t

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about\n\t\t\tcreating and working with virtual MFA devices, go to Using a Virtual MFA Device in Using AWS Identity and Access Management.

\n\t\t

For information about limits on the number of MFA devices you can create, see Limitations on Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tThe seed information contained in the QR code and the Base32 string should be treated\n\t\t\tlike any other secret access information, such as your AWS access keys or your passwords.\n\t\t\tAfter you provision your virtual device, you should ensure that the information is destroyed\n\t\t\tfollowing secure procedures.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=CreateVirtualMFADevice\n&VirtualMFADeviceName=ExampleName\n&Path=/\n&Version=2010-05-08\n&AUTHPARAMS\n\n\t\t\t\n\n \n \n arn:aws:iam::123456789012:mfa/ExampleName\n 2K5K5XTLA7GGE75TQLYEXAMPLEEXAMPLEEXAMPLECHDFW4KJYZ6\n UFQ75LL7COCYKM\n 89504E470D0A1A0AASDFAHSDFKJKLJFKALSDFJASDF \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n\n\t\t\n\t" }, "DeactivateMFADevice": { "name": "DeactivateMFADevice", "input": { "shape_name": "DeactivateMFADeviceRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose MFA device you want to deactivate.

\n\t", "required": true }, "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n\t\t\tserial number is the device ARN.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deactivates the specified MFA device and removes it from association with the user name for\n\t\t\twhich it was originally enabled.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeactivateMFADevice\n&UserName=Bob\n&SerialNumber=R1234\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteAccessKey": { "name": "DeleteAccessKey", "input": { "shape_name": "DeleteAccessKeyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose key you want to delete.

\n\t" }, "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID for the access key ID and secret access key you want to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the access key associated with the specified user.

\n\t\t

If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteAccessKey\n&UserName=Bob\n&AccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteAccountAlias": { "name": "DeleteAccountAlias", "input": { "shape_name": "DeleteAccountAliasRequest", "type": "structure", "members": { "AccountAlias": { "shape_name": "accountAliasType", "type": "string", "min_length": 3, "max_length": 63, "pattern": "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$", "documentation": "\n\t\t

Name of the account alias to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified AWS account alias. For information about using an AWS account alias,\n\t\t\tsee Using an\n\t\t\t\tAlias for Your AWS Account ID in Using AWS Identity and Access Management.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteAccountAlias\n&AccountAlias=foocorporation\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteAccountPasswordPolicy": { "name": "DeleteAccountPasswordPolicy", "input": null, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Deletes the password policy for the AWS account.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteAccountPasswordPolicy\n&Version=2010-05-08\n&AUTHPARAMS\n\n\t\t\t\n\n \n\t 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n\t\n\n\n\t\t\n\t" }, "DeleteGroup": { "name": "DeleteGroup", "input": { "shape_name": "DeleteGroupRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified group. The group must not contain any users or have any attached\n\t\t\tpolicies.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteGroup\n&Group=Test\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteGroupPolicy": { "name": "DeleteGroupPolicy", "input": { "shape_name": "DeleteGroupPolicyRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified policy that is associated with the specified group.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteGroupPolicy\n&GroupName=Admins\n&PolicyName=AdminRoot\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteInstanceProfile": { "name": "DeleteInstanceProfile", "input": { "shape_name": "DeleteInstanceProfileRequest", "type": "structure", "members": { "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the instance profile to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified instance profile. The instance profile must not have an associated\n\t\t\trole.

\n\t\tMake sure you do not have any Amazon EC2 instances running with the instance profile\n\t\t\tyou are about to delete. Deleting a role or instance profile that is associated with a running\n\t\t\tinstance will break any applications running on the instance.\n\t\t

For more information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteInstanceProfile\n&InstanceProfileName=Webserver\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 90c18667-99f3-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "DeleteLoginProfile": { "name": "DeleteLoginProfile", "input": { "shape_name": "DeleteLoginProfileRequest", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose password you want to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the password for the specified user, which terminates the user's ability to access\n\t\t\tAWS services through the AWS Management Console.

\n\t\tDeleting a user's password does not prevent a user from accessing IAM through the\n\t\t\tcommand line interface or the API. To prevent all user access you must also either make the\n\t\t\taccess key inactive or delete it. For more information about making keys inactive or deleting\n\t\t\tthem, see UpdateAccessKey and DeleteAccessKey. \n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteLoginProfile\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteRole": { "name": "DeleteRole", "input": { "shape_name": "DeleteRoleRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified role. The role must not have any policies attached. For more\n\t\t\tinformation about roles, go to Working with\n\t\t\tRoles.

\n\t\tMake sure you do not have any Amazon EC2 instances running with the role you are\n\t\t\tabout to delete. Deleting a role or instance profile that is associated with a running\n\t\t\tinstance will break any applications running on the instance.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteRole\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 913e3f37-99ed-11e1-a4c3-270EXAMPLE04\n \n\n \n\t\t\n\t" }, "DeleteRolePolicy": { "name": "DeleteRolePolicy", "input": { "shape_name": "DeleteRolePolicyRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role the associated with the policy.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to delete.

\n\t", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified policy associated with the specified role.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteRolePolicy\n&PolicyName=S3AccessPolicy\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n c749ee7f-99ef-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "DeleteSAMLProvider": { "name": "DeleteSAMLProvider", "input": { "shape_name": "DeleteSAMLProviderRequest", "type": "structure", "members": { "SAMLProviderArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "InvalidInputException", "type": "structure", "members": { "message": { "shape_name": "invalidInputMessage", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n\t\t

Deletes a SAML provider.

\n\t\t

Deleting the provider does not update any roles that reference the SAML provider as a\n\t\t\tprincipal in their trust policies. Any attempt to assume a role that references a SAML\n\t\t\tprovider that has been deleted will fail.

\n\t\tThis operation requires Signature Version\n\t\t\t4.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\n\t" }, "DeleteServerCertificate": { "name": "DeleteServerCertificate", "input": { "shape_name": "DeleteServerCertificateRequest", "type": "structure", "members": { "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the server certificate you want to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified server certificate.

\n\t\tIf you are using a server certificate with Elastic Load Balancing, deleting the\n\t\t\tcertificate could have implications for your application. If Elastic Load Balancing doesn't\n\t\t\tdetect the deletion of bound certificates, it may continue to use the certificates. This could\n\t\t\tcause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the\n\t\t\treference to the certificate from Elastic Load Balancing before using this command to delete\n\t\t\tthe certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API\n\t\t\t\tReference.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteServerCertificate\n&ServerCertificateName=ProdServerCert\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteSigningCertificate": { "name": "DeleteSigningCertificate", "input": { "shape_name": "DeleteSigningCertificateRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the signing certificate belongs to.

\n\t" }, "CertificateId": { "shape_name": "certificateIdType", "type": "string", "min_length": 24, "max_length": 128, "pattern": "[\\w]*", "documentation": "\n\t\t

ID of the signing certificate to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified signing certificate associated with the specified user.

\n\t\t

If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteSigningCertificate\n&UserName=Bob\n&CertificateId=TA7SMP42TDN5Z26OBPJE7EXAMPLE\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteUser": { "name": "DeleteUser", "input": { "shape_name": "DeleteUserRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified user. The user must not belong to any groups, have any keys or signing\n\t\t\tcertificates, or have any attached policies.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteUser\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteUserPolicy": { "name": "DeleteUserPolicy", "input": { "shape_name": "DeleteUserPolicyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to delete.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes the specified policy associated with the specified user.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteUserPolicy\n&UserName=Bob\n&PolicyName=AllAccessPolicy\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "DeleteVirtualMFADevice": { "name": "DeleteVirtualMFADevice", "input": { "shape_name": "DeleteVirtualMFADeviceRequest", "type": "structure", "members": { "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n\t\t\tserial number is the same as the ARN.

\n\t", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "DeleteConflictException", "type": "structure", "members": { "message": { "shape_name": "deleteConflictMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Deletes a virtual MFA device.

\n\t\tYou must deactivate a user's virtual MFA device before you can delete it. For information\n\t\t\tabout deactivating MFA devices, see DeactivateMFADevice.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=DeleteVirtualMFADevice\n&SerialNumber=arn:aws:iam::123456789012:mfa/ExampleName\n&Version=2010-05-08\n&AUTHPARAMS\n\n\t\t\t\n\n \n \n arn:aws:iam::123456789012:mfa/ExampleName\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n\n\t\t\n\t" }, "EnableMFADevice": { "name": "EnableMFADevice", "input": { "shape_name": "EnableMFADeviceRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user for whom you want to enable the MFA device.

\n\t", "required": true }, "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n\t\t\tserial number is the device ARN.

\n\t", "required": true }, "AuthenticationCode1": { "shape_name": "authenticationCodeType", "type": "string", "min_length": 6, "max_length": 6, "pattern": "[\\d]*", "documentation": "\n\t\t

An authentication code emitted by the device.

\n\t", "required": true }, "AuthenticationCode2": { "shape_name": "authenticationCodeType", "type": "string", "min_length": 6, "max_length": 6, "pattern": "[\\d]*", "documentation": "\n\t\t

A subsequent authentication code emitted by the device.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" }, { "shape_name": "InvalidAuthenticationCodeException", "type": "structure", "members": { "message": { "shape_name": "invalidAuthenticationCodeMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Enables the specified MFA device and associates it with the specified user name. When\n\t\t\tenabled, the MFA device is required for every subsequent login by the user name associated\n\t\t\twith the device.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=EnableMFADevice\n&UserName=Bob\n&SerialNumber=R1234\n&AuthenticationCode1=234567\n&AuthenticationCode2=987654\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "GetAccountPasswordPolicy": { "name": "GetAccountPasswordPolicy", "input": null, "output": { "shape_name": "GetAccountPasswordPolicyResponse", "type": "structure", "members": { "PasswordPolicy": { "shape_name": "PasswordPolicy", "type": "structure", "members": { "MinimumPasswordLength": { "shape_name": "minimumPasswordLengthType", "type": "integer", "min_length": 6, "max_length": 128, "documentation": "\n\t\t

Minimum length to require for IAM user passwords.

\n\t" }, "RequireSymbols": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

Specifies whether to require symbols for IAM user passwords.

\n\t" }, "RequireNumbers": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

Specifies whether to require numbers for IAM user passwords.

\n\t" }, "RequireUppercaseCharacters": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

Specifies whether to require uppercase characters for IAM user passwords.

\n\t" }, "RequireLowercaseCharacters": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

Specifies whether to require lowercase characters for IAM user passwords.

\n\t" }, "AllowUsersToChangePassword": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

Specifies whether to allow IAM users to change their own password.

\n\t" }, "ExpirePasswords": { "shape_name": "booleanType", "type": "boolean", "documentation": null }, "MaxPasswordAge": { "shape_name": "maxPasswordAgeType", "type": "integer", "documentation": null } }, "documentation": "\n\t\t

The PasswordPolicy data type contains information about the account password policy.

\n\t\t

This data type is used as a response element in the action GetAccountPasswordPolicy.\n\t\t

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetAccountPasswordPolicy\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves the password policy for the AWS account. For more information about using a\n\t\t\tpassword policy, go to Managing an\n\t\t\t\tIAM Password Policy.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetAccountPasswordPolicy\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n 6, \n false\n false \n false \n false\n true\n \t\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\t\n\n\t\t\n\t" }, "GetAccountSummary": { "name": "GetAccountSummary", "input": null, "output": { "shape_name": "GetAccountSummaryResponse", "type": "structure", "members": { "SummaryMap": { "shape_name": "summaryMapType", "type": "map", "keys": { "shape_name": "summaryKeyType", "type": "string", "enum": [ "Users", "UsersQuota", "Groups", "GroupsQuota", "ServerCertificates", "ServerCertificatesQuota", "UserPolicySizeQuota", "GroupPolicySizeQuota", "GroupsPerUserQuota", "SigningCertificatesPerUserQuota", "AccessKeysPerUserQuota", "MFADevices", "MFADevicesInUse", "AccountMFAEnabled" ], "documentation": null }, "members": { "shape_name": "summaryValueType", "type": "integer", "documentation": null }, "documentation": "\n\t\t

A set of key value pairs containing account-level information.

\n\t\t

\n\t\t\tSummaryMap contains the following keys:

\n\t\t

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetAccountSummary action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Retrieves account level information about account entity usage and IAM quotas.

\n\t\t

For information about limitations on IAM entities, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetAccountSummary\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n \n Groups\n 31\n \n \n GroupsQuota\n 50\n \n \n UsersQuota\n 150\n \n \n Users\n 35\n \n \n GroupPolicySizeQuota\n 10240\n \n \n AccessKeysPerUserQuota\n 2\n \n \n GroupsPerUserQuota\n 10\n \n \n UserPolicySizeQuota\n 10240\n \n \n SigningCertificatesPerUserQuota\n 2\n \n \n ServerCertificates\n 0\n \n \n ServerCertificatesQuota\n 10\n \n \n AccountMFAEnabled\n 0\n \n \n MFADevicesInUse\n 10\n \n \n MFADevices\n 20\n \n \n \n \n f1e38443-f1ad-11df-b1ef-a9265EXAMPLE\n \n\n \n\t\t\n\t" }, "GetGroup": { "name": "GetGroup", "input": { "shape_name": "GetGroupRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of user names you want\n\t\t\tin the response. If there are additional user names beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "GetGroupResponse", "type": "structure", "members": { "Group": { "shape_name": "Group", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the group.

\n\t", "required": true }, "GroupId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the group was created.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the group.

\n\t", "required": true }, "Users": { "shape_name": "userListType", "type": "list", "members": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The User data type contains information about a user.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of users in the group.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more user names to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more user names in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, then this element is present and contains the value to\n\t\t\tuse for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetGroup action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Returns a list of users that are in the specified group. You can paginate the results using\n\t\t\tthe MaxItems and Marker parameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetGroup\n&GroupName=Admins\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /\n Admins\n AGPACKCEVSQ6C2EXAMPLE\n arn:aws:iam::123456789012:group/Admins\n \n \n \n /division_abc/subdivision_xyz/\n Bob\n AIDACKCEVSQ6C2EXAMPLE\n \n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n \n \n \n /division_abc/subdivision_xyz/\n Susan\n AIDACKCEVSQ6C2EXAMPLE\n \n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Susan\n \n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Users", "py_input_token": "marker" } }, "GetGroupPolicy": { "name": "GetGroupPolicy", "input": { "shape_name": "GetGroupPolicyRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to get.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetGroupPolicyResponse", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The group the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the policy.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetGroupPolicy action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves the specified policy document for the specified group. The returned policy is\n\t\t\tURL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetGroupPolicy\n&GroupName=Admins\n&PolicyName=AdminRoot\n&AUTHPARAMS\n \n\t\t\t\n\n \n Admins\n AdminRoot\n \n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "GetInstanceProfile": { "name": "GetInstanceProfile", "input": { "shape_name": "GetInstanceProfileRequest", "type": "structure", "members": { "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the instance profile to get information about.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetInstanceProfileResponse", "type": "structure", "members": { "InstanceProfile": { "shape_name": "InstanceProfile", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the instance profile.

\n\t", "required": true }, "InstanceProfileId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the instance profile was created.

\n\t", "required": true }, "Roles": { "shape_name": "roleListType", "type": "list", "members": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

The Role data type contains information about a role.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

The role associated with the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetInstanceProfile action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves information about the specified instance profile, including the instance profile's\n\t\t\tpath, GUID, ARN, and role. For more information about instance profiles, go to About Instance\n\t\t\t\tProfiles. For more information about ARNs, go to ARNs.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetInstanceProfile\n&InstanceProfileName=Webserver\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n AIPAD5ARO2C5EXAMPLE3G\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-09T15:45:35Z\n AROACVYKSVTSZFEXAMPLE\n \n \n Webserver\n /application_abc/component_xyz/\n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver\n 2012-05-09T16:11:10Z\n \n \n \n 37289fda-99f2-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "GetLoginProfile": { "name": "GetLoginProfile", "input": { "shape_name": "GetLoginProfileRequest", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose login profile you want to retrieve.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetLoginProfileResponse", "type": "structure", "members": { "LoginProfile": { "shape_name": "LoginProfile", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the user, which can be used for signing into the AWS Management Console.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the password for the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

User name and password create date for the user.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetLoginProfile action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves the user name and password-creation date for the specified user. If the user has\n\t\t\tnot been assigned a password, the action returns a 404 (NoSuchEntity) error.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetLoginProfile\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n Bob\n 2011-09-19T23:00:56Z\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "GetRole": { "name": "GetRole", "input": { "shape_name": "GetRoleRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to get information about.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetRoleResponse", "type": "structure", "members": { "Role": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

Information about the role.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetRole action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves information about the specified role, including the role's path, GUID, ARN, and the\n\t\t\tpolicy granting permission to EC2 to assume the role. For more information about ARNs, go to\n\t\t\t\tARNs. For more information about roles, go to Working with\n\t\t\tRoles.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetRole\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-08T23:34:01Z\n AROADBQP57FF2AEXAMPLE\n \n \n \n df37e965-9967-11e1-a4c3-270EXAMPLE04\n \n\n \n\t\t\n\t" }, "GetRolePolicy": { "name": "GetRolePolicy", "input": { "shape_name": "GetRolePolicyRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role associated with the policy.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to get.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetRolePolicyResponse", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The role the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the policy.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetRolePolicy action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves the specified policy document for the specified role. For more information about\n\t\t\troles, go to Working with\n\t\t\t\tRoles.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetRolePolicy\n&PolicyName=S3AccessPolicy\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n S3AccessPolicy\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}\n \n \n 7e7cd8bc-99ef-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "GetSAMLProvider": { "name": "GetSAMLProvider", "input": { "shape_name": "GetSAMLProviderRequest", "type": "structure", "members": { "SAMLProviderArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider to get information about.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetSAMLProviderResponse", "type": "structure", "members": { "SAMLMetadataDocument": { "shape_name": "SAMLMetadataDocumentType", "type": "string", "min_length": 1000, "max_length": 10000000, "documentation": "\n\t\t

The XML metadata document that includes information about an identity provider.

\n\t" }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date and time when the SAML provider was created.

\n\t" }, "ValidUntil": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The expiration date and time for the SAML provider.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetSAMLProvider action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "InvalidInputException", "type": "structure", "members": { "message": { "shape_name": "invalidInputMessage", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n\t\t

Returns the SAML provider metadocument that was uploaded when the provider was created or\n\t\t\tupdated.

\n\t\tThis operation requires Signature Version\n\t\t\t4.\n\t\t\n\t\t\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 2012-05-09T16:27:11Z\n 2015-12-31T211:59:59Z\n Pd9fexDssTkRgGNqs...DxptfEs==\n \n \n 29f47818-99f5-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "GetServerCertificate": { "name": "GetServerCertificate", "input": { "shape_name": "GetServerCertificateRequest", "type": "structure", "members": { "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the server certificate you want to retrieve information about.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetServerCertificateResponse", "type": "structure", "members": { "ServerCertificate": { "shape_name": "ServerCertificate", "type": "structure", "members": { "ServerCertificateMetadata": { "shape_name": "ServerCertificateMetadata", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the server certificate.

\n\t", "required": true }, "ServerCertificateId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the server certificate was uploaded.

\n\t" } }, "documentation": "\n\t\t

The meta information of the server certificate, such as its name, path, ID, and ARN.

\n\t", "required": true }, "CertificateBody": { "shape_name": "certificateBodyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "documentation": "\n\t\t

The contents of the public key certificate.

\n\t", "required": true }, "CertificateChain": { "shape_name": "certificateChainType", "type": "string", "min_length": 1, "max_length": 2097152, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*", "documentation": "\n\t\t

The contents of the public key certificate chain.

\n\t" } }, "documentation": "\n\t\t

Information about the server certificate.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetServerCertificate action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves information about the specified server certificate.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetServerCertificate\n&ServerCertificateName=ProdServerCert\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n \n ProdServerCert\n /company/servercerts/\n arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert\n 2010-05-08T01:02:03.004Z\n ASCACKCEVSQ6C2EXAMPLE\n \n -----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "GetUser": { "name": "GetUser", "input": { "shape_name": "GetUserRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to get information about.

\n\t\t

This parameter is optional. If it is not included, it defaults to the user making the\n\t\t\trequest.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "GetUserResponse", "type": "structure", "members": { "User": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

Information about the user.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetUser action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves information about the specified user, including the user's path, unique ID, and\n\t\t\tARN.

\n\t\t

If you do not specify a user name, IAM determines the user name implicitly based on the AWS\n\t\t\taccess key ID signing the request.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetUser\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /division_abc/subdivision_xyz/\n Bob\n AIDACKCEVSQ6C2EXAMPLE\n \n arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/Bob\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "GetUserPolicy": { "name": "GetUserPolicy", "input": { "shape_name": "GetUserPolicyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user who the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document to get.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "GetUserPolicyResponse", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The user the policy is associated with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the policy.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the GetUserPolicy action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Retrieves the specified policy document for the specified user. The returned policy is\n\t\t\tURL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=GetUserPolicy\n&UserName=Bob\n&PolicyName=AllAccessPolicy\n&AUTHPARAMS\n \n\t\t\t\n\n \n Bob\n AllAccessPolicy\n \n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "ListAccessKeys": { "name": "ListAccessKeys", "input": { "shape_name": "ListAccessKeysRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of keys you\n\t\t\twant in the response. If there are additional keys beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListAccessKeysResponse", "type": "structure", "members": { "AccessKeyMetadata": { "shape_name": "accessKeyMetadataListType", "type": "list", "members": { "shape_name": "AccessKeyMetadata", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the key is associated with.

\n\t" }, "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The ID for this access key.

\n\t" }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status of the access key. Active means the key is valid for API calls, while\n\t\t\t\tInactive means it is not.

\n\t" }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the access key was created.

\n\t" } }, "documentation": "\n\t\t

The AccessKey data type contains information about an AWS access key, without its secret\n\t\t\tkey.

\n\t\t

This data type is used as a response element in the action ListAccessKeys.

\n\t" }, "documentation": "\n\t\t

A list of access key metadata.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more keys to list. If your results were truncated,\n\t\t\tyou can make a subsequent pagination request using the Marker request parameter\n\t\t\tto retrieve more keys in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListAccessKeys action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Returns information about the access key IDs associated with the specified user. If there are\n\t\t\tnone, the action returns an empty list.

\n\t\t

Although each user is limited to a small number of keys, you can still paginate the results\n\t\t\tusing the MaxItems and Marker parameters.

\n\t\t

If the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.

\n\t\tTo ensure the security of your AWS account, the secret access key is accessible only\n\t\t\tduring key and user creation.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListAccessKeys\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n Bob\n \n \n Bob\n AKIAIOSFODNN7EXAMPLE\n Active\n \n \n Bob\n AKIAI44QH8DHBEXAMPLE\n Inactive\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "AccessKeyMetadata", "py_input_token": "marker" } }, "ListAccountAliases": { "name": "ListAccountAliases", "input": { "shape_name": "ListAccountAliasesRequest", "type": "structure", "members": { "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of account aliases you\n\t\t\twant in the response. If there are additional account aliases beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListAccountAliasesResponse", "type": "structure", "members": { "AccountAliases": { "shape_name": "accountAliasListType", "type": "list", "members": { "shape_name": "accountAliasType", "type": "string", "min_length": 3, "max_length": 63, "pattern": "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$", "documentation": null }, "documentation": "\n\t\t

A list of aliases associated with the account.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more account aliases to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more account aliases in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListAccountAliases action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the account aliases associated with the account. For information about using an AWS\n\t\t\taccount alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and\n\t\t\t\tAccess Management.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListAccountAliases\n&Version=2010-05-08\n&AUTHPARAMS \n \n\t\t\t\n\n \n false\n \n foocorporation\n \n \n \n c5a076e9-f1b0-11df-8fbe-45274EXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "AccountAliases", "py_input_token": "marker" } }, "ListGroupPolicies": { "name": "ListGroupPolicies", "input": { "shape_name": "ListGroupPoliciesRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the group to list policies for.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of policy names you want\n\t\t\tin the response. If there are additional policy names beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListGroupPoliciesResponse", "type": "structure", "members": { "PolicyNames": { "shape_name": "policyNameListType", "type": "list", "members": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": null }, "documentation": "\n\t\t

A list of policy names.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more policy names to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more policy names in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListGroupPolicies action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the names of the policies associated with the specified group. If there are none, the\n\t\t\taction returns an empty list.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListGroupPolicies\n&GroupName=Admins\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n AdminRoot\n KeyPolicy\n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" } }, "ListGroups": { "name": "ListGroups", "input": { "shape_name": "ListGroupsRequest", "type": "structure", "members": { "PathPrefix": { "shape_name": "pathPrefixType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "\\u002F[\\u0021-\\u007F]*", "documentation": "\n\t\t

The path prefix for filtering the results. For example:\n\t\t\t\t/division_abc/subdivision_xyz/, which would get all groups whose path starts\n\t\t\twith /division_abc/subdivision_xyz/.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/), listing all\n\t\t\tgroups.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of groups you want in\n\t\t\tthe response. If there are additional groups beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListGroupsResponse", "type": "structure", "members": { "Groups": { "shape_name": "groupListType", "type": "list", "members": { "shape_name": "Group", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the group.

\n\t", "required": true }, "GroupId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the group was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The Group data type contains information about a group.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of groups.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more groups to list. If your results were truncated,\n\t\t\tyou can make a subsequent pagination request using the Marker request parameter\n\t\t\tto retrieve more groups in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListGroups action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the groups that have the specified path prefix.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListGroups\n&PathPrefix=/division_abc/subdivision_xyz/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n \n /division_abc/subdivision_xyz/\n Admins\n AGPACKCEVSQ6C2EXAMPLE\n arn:aws:iam::123456789012:group/Admins\n \n \n /division_abc/subdivision_xyz/product_1234/engineering/\n \n Test\n AGP2MAB8DPLSRHEXAMPLE\n arn:aws:iam::123456789012:group\n /division_abc/subdivision_xyz/product_1234/engineering/Test\n \n \n /division_abc/subdivision_xyz/product_1234/\n Managers\n AGPIODR4TAW7CSEXAMPLE\n arn:aws:iam::123456789012\n :group/division_abc/subdivision_xyz/product_1234/Managers\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Groups", "py_input_token": "marker" } }, "ListGroupsForUser": { "name": "ListGroupsForUser", "input": { "shape_name": "ListGroupsForUserRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the user to list groups for.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of groups you want in\n\t\t\tthe response. If there are additional groups beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListGroupsForUserResponse", "type": "structure", "members": { "Groups": { "shape_name": "groupListType", "type": "list", "members": { "shape_name": "Group", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the group.

\n\t", "required": true }, "GroupId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the group was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The Group data type contains information about a group.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of groups.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more groups to list. If your results were truncated,\n\t\t\tyou can make a subsequent pagination request using the Marker request parameter\n\t\t\tto retrieve more groups in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListGroupsForUser action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the groups the specified user belongs to.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\n\t\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListGroupsForUser\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\t\t\t\n\t\t\t\t\n \n \n \n \n /\n Admins\n AGPACKCEVSQ6C2EXAMPLE\n arn:aws:iam::123456789012:group/Admins\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n\n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Groups", "py_input_token": "marker" } }, "ListInstanceProfiles": { "name": "ListInstanceProfiles", "input": { "shape_name": "ListInstanceProfilesRequest", "type": "structure", "members": { "PathPrefix": { "shape_name": "pathPrefixType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "\\u002F[\\u0021-\\u007F]*", "documentation": "\n\t\t

The path prefix for filtering the results. For example:\n\t\t\t\t/application_abc/component_xyz/, which would get all instance profiles whose\n\t\t\tpath starts with /application_abc/component_xyz/.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/), listing all\n\t\t\tinstance profiles.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListInstanceProfilesResponse", "type": "structure", "members": { "InstanceProfiles": { "shape_name": "instanceProfileListType", "type": "list", "members": { "shape_name": "InstanceProfile", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the instance profile.

\n\t", "required": true }, "InstanceProfileId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the instance profile was created.

\n\t", "required": true }, "Roles": { "shape_name": "roleListType", "type": "list", "members": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

The Role data type contains information about a role.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

The role associated with the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

The InstanceProfile data type contains information about an instance profile.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of instance profiles.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more instance profiles to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more instance profiles in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListInstanceProfiles action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the instance profiles that have the specified path prefix. If there are none, the\n\t\t\taction returns an empty list. For more information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListInstanceProfiles\n&MaxItems=100\n&PathPrefix=/application_abc/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n false\n \n \n AIPACIFN4OZXG7EXAMPLE\n \n Database\n /application_abc/component_xyz/\n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database\n 2012-05-09T16:27:03Z\n \n \n AIPACZLSXM2EYYEXAMPLE\n \n Webserver\n /application_abc/component_xyz/\n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver\n 2012-05-09T16:27:11Z\n \n \n \n \n fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "InstanceProfiles", "py_input_token": "marker" } }, "ListInstanceProfilesForRole": { "name": "ListInstanceProfilesForRole", "input": { "shape_name": "ListInstanceProfilesForRoleRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the role to list instance profiles for.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": null }, "output": { "shape_name": "ListInstanceProfilesForRoleResponse", "type": "structure", "members": { "InstanceProfiles": { "shape_name": "instanceProfileListType", "type": "list", "members": { "shape_name": "InstanceProfile", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the instance profile.

\n\t", "required": true }, "InstanceProfileId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the instance profile was created.

\n\t", "required": true }, "Roles": { "shape_name": "roleListType", "type": "list", "members": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

The Role data type contains information about a role.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

The role associated with the instance profile.

\n\t", "required": true } }, "documentation": "\n\t\t

The InstanceProfile data type contains information about an instance profile.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of instance profiles.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more instance profiles to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more instance profiles in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListInstanceProfilesForRole\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the instance profiles that have the specified associated role. If there are none, the\n\t\t\taction returns an empty list. For more information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListInstanceProfilesForRole\n&MaxItems=100\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n false\n \n \n AIPACZLS2EYYXMEXAMPLE\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-09T15:45:35Z\n AROACVSVTSZYK3EXAMPLE\n \n \n Webserver\n /application_abc/component_xyz/\n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver\n 2012-05-09T16:27:11Z\n \n \n \n \n 6a8c3992-99f4-11e1-a4c3-27EXAMPLE804\n \n\n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "InstanceProfiles", "py_input_token": "marker" } }, "ListMFADevices": { "name": "ListMFADevices", "input": { "shape_name": "ListMFADevicesRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose MFA devices you want to list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of MFA devices you want\n\t\t\tin the response. If there are additional MFA devices beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListMFADevicesResponse", "type": "structure", "members": { "MFADevices": { "shape_name": "mfaDeviceListType", "type": "list", "members": { "shape_name": "MFADevice", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The user with whom the MFA device is associated.

\n\t", "required": true }, "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the\n\t\t\tserial number is the device ARN.

\n\t", "required": true }, "EnableDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the MFA device was enabled for the user.

\n\t", "required": true } }, "documentation": "\n\t\t

The MFADevice data type contains information about an MFA device.

\n\t\t

This data type is used as a response element in the action ListMFADevices.

\n\t" }, "documentation": "\n\t\t

A list of MFA devices.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more MFA devices to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more MFA devices in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListMFADevices action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the MFA devices. If the request includes the user name, then this action lists all the\n\t\t\tMFA devices associated with the specified user name. If you do not specify a user name, IAM\n\t\t\tdetermines the user name implicitly based on the AWS access key ID signing the request.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListMFADevices\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n \n Bob\n R1234\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "MFADevices", "py_input_token": "marker" } }, "ListRolePolicies": { "name": "ListRolePolicies", "input": { "shape_name": "ListRolePoliciesRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the role to list policies for.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListRolePoliciesResponse", "type": "structure", "members": { "PolicyNames": { "shape_name": "policyNameListType", "type": "list", "members": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": null }, "documentation": "\n\t\t

A list of policy names.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more policy names to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more policy names in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListRolePolicies action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the names of the policies associated with the specified role. If there are none, the\n\t\t\taction returns an empty list.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListRolePolicies\n&MaxItems=100\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n CloudwatchPutMetricPolicy\n S3AccessPolicy\n \n false\n \n \n 8c7e1816-99f0-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" } }, "ListRoles": { "name": "ListRoles", "input": { "shape_name": "ListRolesRequest", "type": "structure", "members": { "PathPrefix": { "shape_name": "pathPrefixType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "\\u002F[\\u0021-\\u007F]*", "documentation": "\n\t\t

The path prefix for filtering the results. For example:\n\t\t\t\t/application_abc/component_xyz/, which would get all roles whose path starts\n\t\t\twith /application_abc/component_xyz/.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/), listing all\n\t\t\troles.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListRolesResponse", "type": "structure", "members": { "Roles": { "shape_name": "roleListType", "type": "list", "members": { "shape_name": "Role", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the role.

\n\t", "required": true }, "RoleId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the role was created.

\n\t", "required": true }, "AssumeRolePolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t" } }, "documentation": "\n\t\t

The Role data type contains information about a role.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of roles.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more roles to list. If your results were truncated,\n\t\t\tyou can make a subsequent pagination request using the Marker request parameter\n\t\t\tto retrieve more roles in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListRoles action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the roles that have the specified path prefix. If there are none, the action returns an\n\t\t\tempty list. For more information about roles, go to Working with\n\t\t\tRoles.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t

The returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListRoles\n&MaxItems=100\n&PathPrefix=/application_abc/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n false\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access\n S3Access\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-09T15:45:35Z\n AROACVSVTSZYEXAMPLEYK\n \n \n /application_abc/component_xyz/\n arn:aws:iam::123456789012:role/application_abc/component_xyz/SDBAccess\n SDBAccess\n {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n 2012-05-09T15:45:45Z\n AROAC2ICXG32EXAMPLEWK\n \n \n \n \n 20f7279f-99ee-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Roles", "py_input_token": "marker" } }, "ListSAMLProviders": { "name": "ListSAMLProviders", "input": { "shape_name": "ListSAMLProvidersRequest", "type": "structure", "members": {}, "documentation": " " }, "output": { "shape_name": "ListSAMLProvidersResponse", "type": "structure", "members": { "SAMLProviderList": { "shape_name": "SAMLProviderListType", "type": "list", "members": { "shape_name": "SAMLProviderListEntry", "type": "structure", "members": { "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider.

\n\t" }, "ValidUntil": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The expiration date and time for the SAML provider.

\n\t" }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date and time when the SAML provider was created.

\n\t" } }, "documentation": "\n\t\t

The list of SAML providers for this account.

\n\t" }, "documentation": "\n\t\t

The list of SAML providers for this account.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListSAMLProviders action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the SAML providers in the account.

\n\t\tThis operation requires Signature Version\n\t\t\t4.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListSAMLProviders\n&MaxItems=100\n&PathPrefix=/application_abc/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n \n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database\n 2032-05-09T16:27:11Z\n 2012-05-09T16:27:03Z\n \n \n arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver\n 2015-03-11T13:11:02Z\n 2012-05-09T16:27:11Z\n \n \n \n \n fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "ListServerCertificates": { "name": "ListServerCertificates", "input": { "shape_name": "ListServerCertificatesRequest", "type": "structure", "members": { "PathPrefix": { "shape_name": "pathPrefixType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "\\u002F[\\u0021-\\u007F]*", "documentation": "\n\t\t

The path prefix for filtering the results. For example: /company/servercerts\n\t\t\twould get all server certificates for which the path starts with\n\t\t\t\t/company/servercerts.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/), listing all\n\t\t\tserver certificates.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of server certificates\n\t\t\tyou want in the response. If there are additional server certificates beyond the maximum you\n\t\t\tspecify, the IsTruncated response element will be set to true. This\n\t\t\tparameter is optional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListServerCertificatesResponse", "type": "structure", "members": { "ServerCertificateMetadataList": { "shape_name": "serverCertificateMetadataListType", "type": "list", "members": { "shape_name": "ServerCertificateMetadata", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the server certificate.

\n\t", "required": true }, "ServerCertificateId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the server certificate was uploaded.

\n\t" } }, "documentation": "\n\t\t

ServerCertificateMetadata contains information about a server certificate without its\n\t\t\tcertificate body, certificate chain, and private key.

\n\t\t

This data type is used as a response element in the action UploadServerCertificate and\n\t\t\t\tListServerCertificates.

\n\t" }, "documentation": "\n\t\t

A list of server certificates.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more server certificates to list. If your results\n\t\t\twere truncated, you can make a subsequent pagination request using the Marker\n\t\t\trequest parameter to retrieve more server certificates in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListServerCertificates\n\t\t\taction.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the server certificates that have the specified path prefix. If none exist, the action\n\t\t\treturns an empty list.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListServerCertificates\n&PathPrefix=/company/servercerts\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n false\n \n \n \n ProdServerCert\n /company/servercerts/\n arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert\n 2010-05-08T01:02:03.004Z\n ASCACKCEVSQ6CEXAMPLE1\n \n \n \n \n BetaServerCert\n /company/servercerts/\n arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert\n 2010-05-08T02:03:01.004Z\n ASCACKCEVSQ6CEXAMPLE2\n \n \n \n \n TestServerCert\n /company/servercerts/\n arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert\n 2010-05-08T03:01:02.004Z\n ASCACKCEVSQ6CEXAMPLE3\n \n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "ServerCertificateMetadataList", "py_input_token": "marker" } }, "ListSigningCertificates": { "name": "ListSigningCertificates", "input": { "shape_name": "ListSigningCertificatesRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the user.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of certificate IDs you\n\t\t\twant in the response. If there are additional certificate IDs beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListSigningCertificatesResponse", "type": "structure", "members": { "Certificates": { "shape_name": "certificateListType", "type": "list", "members": { "shape_name": "SigningCertificate", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the signing certificate is associated with.

\n\t", "required": true }, "CertificateId": { "shape_name": "certificateIdType", "type": "string", "min_length": 24, "max_length": 128, "pattern": "[\\w]*", "documentation": "\n\t\t

The ID for the signing certificate.

\n\t", "required": true }, "CertificateBody": { "shape_name": "certificateBodyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "documentation": "\n\t\t

The contents of the signing certificate.

\n\t", "required": true }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status of the signing certificate. Active means the key is valid for API\n\t\t\tcalls, while Inactive means it is not.

\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the signing certificate was uploaded.

\n\t" } }, "documentation": "\n\t\t

The SigningCertificate data type contains information about an X.509 signing certificate.

\n\t\t

This data type is used as a response element in the actions UploadSigningCertificate\n\t\t\tand ListSigningCertificates.

\n\t" }, "documentation": "\n\t\t

A list of the user's signing certificate information.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more certificate IDs to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more certificates in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListSigningCertificates\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Returns information about the signing certificates associated with the specified user. If\n\t\t\tthere are none, the action returns an empty list.

\n\t\t

Although each user is limited to a small number of signing certificates, you can still\n\t\t\tpaginate the results using the MaxItems and Marker parameters.

\n\t\t

If the UserName field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListSigningCertificates\n&UserName=Bob\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n Bob\n \n \n Bob\n TA7SMP42TDN5Z26OBPJE7EXAMPLE\n -----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----\n Active\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Certificates", "py_input_token": "marker" } }, "ListUserPolicies": { "name": "ListUserPolicies", "input": { "shape_name": "ListUserPoliciesRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the user to list policies for.

\n\t", "required": true }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this only when paginating results, and only in a subsequent request after you've received\n\t\t\ta response where the results are truncated. Set it to the value of the Marker\n\t\t\telement in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this only when paginating results to indicate the maximum number of policy names you want\n\t\t\tin the response. If there are additional policy names beyond the maximum you specify, the\n\t\t\t\tIsTruncated response element is true. This parameter is optional.\n\t\t\tIf you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListUserPoliciesResponse", "type": "structure", "members": { "PolicyNames": { "shape_name": "policyNameListType", "type": "list", "members": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": null }, "documentation": "\n\t\t

A list of policy names.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more policy names to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more policy names in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListUserPolicies action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Lists the names of the policies associated with the specified user. If there are none, the\n\t\t\taction returns an empty list.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListUserPolicies\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n AllAccessPolicy\n KeyPolicy\n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" } }, "ListUsers": { "name": "ListUsers", "input": { "shape_name": "ListUsersRequest", "type": "structure", "members": { "PathPrefix": { "shape_name": "pathPrefixType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "\\u002F[\\u0021-\\u007F]*", "documentation": "\n\t\t

The path prefix for filtering the results. For example:\n\t\t\t\t/division_abc/subdivision_xyz/, which would get all user names whose path\n\t\t\tstarts with /division_abc/subdivision_xyz/.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/), listing all\n\t\t\tuser names.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "ListUsersResponse", "type": "structure", "members": { "Users": { "shape_name": "userListType", "type": "list", "members": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The User data type contains information about a user.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "documentation": "\n\t\t

A list of users.

\n\t", "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more user names to list. If your results were\n\t\t\ttruncated, you can make a subsequent pagination request using the Marker request\n\t\t\tparameter to retrieve more users in the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListUsers action.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the users that have the specified path prefix. If there are none, the action returns an\n\t\t\tempty list.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ListUsers\n&PathPrefix=/division_abc/subdivision_xyz/product_1234/engineering/\n&Version=2010-05-08\n&AUTHPARAMS\n \n\n\t\t\t\n\n \n \n \n /division_abc/subdivision_xyz/engineering/\n Andrew\n AID2MAB8DPLSRHEXAMPLE\n arn:aws:iam::123456789012:user\n /division_abc/subdivision_xyz/engineering/Andrew\n \n \n /division_abc/subdivision_xyz/engineering/\n Jackie\n AIDIODR4TAW7CSEXAMPLE\n arn:aws:iam::123456789012:user\n /division_abc/subdivision_xyz/engineering/Jackie\n \n \n false\n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Users", "py_input_token": "marker" } }, "ListVirtualMFADevices": { "name": "ListVirtualMFADevices", "input": { "shape_name": "ListVirtualMFADevicesRequest", "type": "structure", "members": { "AssignmentStatus": { "shape_name": "assignmentStatusType", "type": "string", "enum": [ "Assigned", "Unassigned", "Any" ], "documentation": "\n\t\t

The status (unassigned or assigned) of the devices to list. If you do not specify an\n\t\t\t\tAssignmentStatus, the action defaults to Any which lists both\n\t\t\tassigned and unassigned virtual MFA devices.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

Use this parameter only when paginating results, and only in a subsequent request after\n\t\t\tyou've received a response where the results are truncated. Set it to the value of the\n\t\t\t\tMarker element in the response you just received.

\n\t" }, "MaxItems": { "shape_name": "maxItemsType", "type": "integer", "min_length": 1, "max_length": 1000, "documentation": "\n\t\t

Use this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.

\n\t" } }, "documentation": null }, "output": { "shape_name": "ListVirtualMFADevicesResponse", "type": "structure", "members": { "VirtualMFADevices": { "shape_name": "virtualMFADeviceListType", "type": "list", "members": { "shape_name": "VirtualMFADevice", "type": "structure", "members": { "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The serial number associated with VirtualMFADevice.

\n\t", "required": true }, "Base32StringSeed": { "shape_name": "BootstrapDatum", "type": "blob", "sensitive": true, "documentation": "\n\t\t

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

\n\t" }, "QRCodePNG": { "shape_name": "BootstrapDatum", "type": "blob", "sensitive": true, "documentation": "\n\t\t

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?\n\t\t\t\tsecret=$Base32String where $virtualMFADeviceName is one of the create call arguments,\n\t\t\tAccountName is the user name if set (accountId otherwise), and Base32String is the seed in\n\t\t\tBase32 format. The Base32String is Base64-encoded.

\n\t" }, "User": { "shape_name": "User", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name identifying the user.

\n\t", "required": true }, "UserId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "CreateDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the user was created.

\n\t", "required": true } }, "documentation": "\n\t\t

The User data type contains information about a user.

\n\t\t

This data type is used as a response element in the following actions:

\n\t\t\n\t" }, "EnableDate": { "shape_name": "dateType", "type": "timestamp", "documentation": null } }, "documentation": "\n\t\t

The VirtualMFADevice data type contains information about a virtual MFA\n\t\t\tdevice.

\n\t" }, "documentation": null, "required": true }, "IsTruncated": { "shape_name": "booleanType", "type": "boolean", "documentation": "\n\t\t

A flag that indicates whether there are more items to list. If your results were truncated,\n\t\t\tyou can make a subsequent pagination request using the Marker request parameter\n\t\t\tto retrieve more items the list.

\n\t" }, "Marker": { "shape_name": "markerType", "type": "string", "min_length": 1, "max_length": 320, "pattern": "[\\u0020-\\u00FF]*", "documentation": "\n\t\t

If IsTruncated is true, this element is present and contains the\n\t\t\tvalue to use for the Marker parameter in a subsequent pagination request.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the ListVirtualMFADevices\n\t\t\taction.

\n\t" }, "errors": [], "documentation": "\n\t\t

Lists the virtual MFA devices under the AWS account by assignment status. If you do not\n\t\t\tspecify an assignment status, the action returns a list of all virtual MFA devices. Assignment\n\t\t\tstatus can be Assigned, Unassigned, or Any.

\n\t\t

You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.

\n\t\t\n\t\t\t\n\n \nhttps://iam.amazonaws.com/\n?Action=ListVirtualMFADevices\n&AssignmentStatus=Any\n&AUTHPARAMS\n\n\t\t\t\n\n\n\n \n false\n \n \n \n arn:aws:iam::123456789012:mfa/MFAdeviceName\n \n \n \n \n arn:aws:iam::123456789012:mfa/RootMFAdeviceName\n \n 2011-10-20T20:49:03Z\n \n 123456789012\n arn:aws:iam::123456789012:root\n 2009-10-13T22:00:36Z\n \n \n \n \n arn:aws:iam:::mfa/ExampleUserMFAdeviceName\n \n 2011-10-31T20:45:02Z\n \n AIDEXAMPLE4EXAMPLEXYZ\n /\n ExampleUser\n arn:aws:iam::111122223333:user/ExampleUser\n 2011-07-01T17:23:07Z\n \n \n \n \n \n b61ce1b1-0401-11e1-b2f8-2dEXAMPLEbfc\n \n\n\n\t\t\n\t", "pagination": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "VirtualMFADevices", "py_input_token": "marker" } }, "PutGroupPolicy": { "name": "PutGroupPolicy", "input": { "shape_name": "PutGroupPolicyRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to associate the policy with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Adds (or updates) a policy document associated with the specified group. For information\n\t\t\tabout policies, refer to Overview of Policies in Using AWS Identity and Access Management.

\n\t\t

For information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tBecause policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\tPutGroupPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=PutGroupPolicy\n&GroupName=Admins\n&PolicyName=AdminRoot\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "PutRolePolicy": { "name": "PutRolePolicy", "input": { "shape_name": "PutRolePolicyRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to associate the policy with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Adds (or updates) a policy document associated with the specified role. For information about\n\t\t\tpolicies, go to Overview of Policies in Using AWS Identity and Access Management.

\n\t\t

For information about limits on the policies you can associate with a role, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tBecause policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\tPutRolePolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=PutRolePolicy\n&RoleName=S3Access\n&PolicyName=S3AccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "PutUserPolicy": { "name": "PutUserPolicy", "input": { "shape_name": "PutUserPolicyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to associate the policy with.

\n\t", "required": true }, "PolicyName": { "shape_name": "policyNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the policy document.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy document.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Adds (or updates) a policy document associated with the specified user. For information about\n\t\t\tpolicies, refer to Overview of Policies in Using AWS Identity and Access Management.

\n\t\t

For information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tBecause policy documents can be large, you should use POST rather than GET when calling\n\t\t\t\tPutUserPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=PutUserPolicy\n&UserName=Bob\n&PolicyName=AllAccessPolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}]}\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "RemoveRoleFromInstanceProfile": { "name": "RemoveRoleFromInstanceProfile", "input": { "shape_name": "RemoveRoleFromInstanceProfileRequest", "type": "structure", "members": { "InstanceProfileName": { "shape_name": "instanceProfileNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the instance profile to update.

\n\t", "required": true }, "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to remove.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Removes the specified role from the specified instance profile.

\n\t\tMake sure you do not have any Amazon EC2 instances running with the role you are\n\t\t\tabout to remove from the instance profile. Removing a role from an instance profile that is\n\t\t\tassociated with a running instance will break any applications running on the\n\t\t\tinstance.\n\t\t

For more information about roles, go to Working with Roles.\n\t\t\tFor more information about instance profiles, go to About Instance\n\t\t\t\tProfiles.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=RemoveRoleFromInstanceProfile\n&InstanceProfileName=Webserver\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 29f47818-99f5-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "RemoveUserFromGroup": { "name": "RemoveUserFromGroup", "input": { "shape_name": "RemoveUserFromGroupRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to update.

\n\t", "required": true }, "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to remove.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Removes the specified user from the specified group.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=RemoveUserFromGroup\n&GroupName=Managers\n&UserName=Bob\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "ResyncMFADevice": { "name": "ResyncMFADevice", "input": { "shape_name": "ResyncMFADeviceRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose MFA device you want to resynchronize.

\n\t", "required": true }, "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

Serial number that uniquely identifies the MFA device.

\n\t", "required": true }, "AuthenticationCode1": { "shape_name": "authenticationCodeType", "type": "string", "min_length": 6, "max_length": 6, "pattern": "[\\d]*", "documentation": "\n\t\t

An authentication code emitted by the device.

\n\t", "required": true }, "AuthenticationCode2": { "shape_name": "authenticationCodeType", "type": "string", "min_length": 6, "max_length": 6, "pattern": "[\\d]*", "documentation": "\n\t\t

A subsequent authentication code emitted by the device.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "InvalidAuthenticationCodeException", "type": "structure", "members": { "message": { "shape_name": "invalidAuthenticationCodeMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Synchronizes the specified MFA device with AWS servers.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=ResyncMFADevice\n&UserName=Bob\n&SerialNumber=R1234\n&AuthenticationCode1=234567\n&AuthenticationCode2=987654\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateAccessKey": { "name": "UpdateAccessKey", "input": { "shape_name": "UpdateAccessKeyRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose key you want to update.

\n\t" }, "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID of the secret access key you want to update.

\n\t", "required": true }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status you want to assign to the secret access key. Active means the key can\n\t\t\tbe used for API calls to AWS, while Inactive means the key cannot be used.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Changes the status of the specified access key from Active to Inactive, or vice versa. This\n\t\t\taction can be used to disable a user's key as part of a key rotation work flow.

\n\t\t

If the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.

\n\t\t

For information about rotating keys, see Managing Keys and Certificates in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateAccessKey\n&UserName=Bob\n&AccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateAccountPasswordPolicy": { "name": "UpdateAccountPasswordPolicy", "input": { "shape_name": "UpdateAccountPasswordPolicyRequest", "type": "structure", "members": { "MinimumPasswordLength": { "shape_name": "minimumPasswordLengthType", "type": "integer", "min_length": 6, "max_length": 128, "documentation": null }, "RequireSymbols": { "shape_name": "booleanType", "type": "boolean", "documentation": null }, "RequireNumbers": { "shape_name": "booleanType", "type": "boolean", "documentation": null }, "RequireUppercaseCharacters": { "shape_name": "booleanType", "type": "boolean", "documentation": null }, "RequireLowercaseCharacters": { "shape_name": "booleanType", "type": "boolean", "documentation": null }, "AllowUsersToChangePassword": { "shape_name": "booleanType", "type": "boolean", "documentation": null } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Updates the password policy settings for the account. For more information about using a\n\t\t\tpassword policy, go to Managing an\n\t\t\t\tIAM Password Policy.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateAccountPasswordPolicy\n&MinimumPasswordLength=9\n&RequireSymbols=true\n&RequireNumbers=false\n&RequireUppercaseCharacters=true\n&RequireLowercaseCharacters=true\n&AllowUsersToChangePassword=true\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n\n\t\t\n\t" }, "UpdateAssumeRolePolicy": { "name": "UpdateAssumeRolePolicy", "input": { "shape_name": "UpdateAssumeRolePolicyRequest", "type": "structure", "members": { "RoleName": { "shape_name": "roleNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the role to update.

\n\t", "required": true }, "PolicyDocument": { "shape_name": "policyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 131072, "documentation": "\n\t\t

The policy that grants an entity permission to assume the role.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Updates the policy that grants an entity permission to assume a role. Currently, only an\n\t\t\tAmazon EC2 instance can assume a role. For more information about roles, go to Working with\n\t\t\tRoles.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateAssumeRolePolicy\n&PolicyDocument={\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}\n&RoleName=S3Access\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 309c1671-99ed-11e1-a4c3-270EXAMPLE04\n \n\n \n\t\t\n\t" }, "UpdateGroup": { "name": "UpdateGroup", "input": { "shape_name": "UpdateGroupRequest", "type": "structure", "members": { "GroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the group to update. If you're changing the name of the group, this is the original\n\t\t\tname.

\n\t", "required": true }, "NewPath": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

New path for the group. Only include this if changing the group's path.

\n\t" }, "NewGroupName": { "shape_name": "groupNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

New name for the group. Only include this if changing the group's name.

\n\t" } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Updates the name and/or the path of the specified group.

\n\t\t You should understand the implications of changing a group's path or name. For more\n\t\t\tinformation, see Renaming Users and Groups in Using AWS Identity and Access\n\t\t\t\tManagement. \n\t\tTo change a group name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Managers to MGRs, the entity making the\n\t\t\trequest must have permission on Managers and MGRs, or must have permission on all (*). For\n\t\t\tmore information about permissions, see Permissions and Policies. \n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateGroup\n&GroupName=Test\n&NewGroupName=Test_1\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /division_abc/subdivision_xyz/product_1234/engineering/\n Test_1\n AGP2MAB8DPLSRHEXAMPLE\n arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/\n product_1234/engineering/Test_1\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateLoginProfile": { "name": "UpdateLoginProfile", "input": { "shape_name": "UpdateLoginProfileRequest", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user whose password you want to update.

\n\t", "required": true }, "Password": { "shape_name": "passwordType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, "documentation": "\n\t\t

The new password for the user name.

\n\t", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "PasswordPolicyViolationException", "type": "structure", "members": { "message": { "shape_name": "passwordPolicyViolationMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the provided password did not meet the requirements imposed\n\t\t\tby the account password policy.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Changes the password for the specified user.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateLoginProfile\n&UserName=Bob\n&Password=NewPassword\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateSAMLProvider": { "name": "UpdateSAMLProvider", "input": { "shape_name": "UpdateSAMLProviderRequest", "type": "structure", "members": { "SAMLMetadataDocument": { "shape_name": "SAMLMetadataDocumentType", "type": "string", "min_length": 1000, "max_length": 10000000, "documentation": "\n\t\t

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP.

\n\t", "required": true }, "SAMLProviderArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider to update.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "UpdateSAMLProviderResponse", "type": "structure", "members": { "SAMLProviderArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider that was updated.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the UpdateSAMLProvider action.

\n\t" }, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "InvalidInputException", "type": "structure", "members": { "message": { "shape_name": "invalidInputMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Updates the metadata document for an existing SAML provider.

\n\t\tThis operation requires Signature Version\n\t\t\t4.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateSAMLProvider\n&Name=arn:aws:iam::123456789012:saml-metadata/MyUniversity\n&SAMLProviderDocument=VGhpcyBpcyB3aGVyZSB5b3UgcHV0IHRoZSBTQU1MIHByb3ZpZGVyIG1ldGFkYXRhIGRvY3VtZW50\nLCBCYXNlNjQtZW5jb2RlZCBpbnRvIGEgYmlnIHN0cmluZy4=\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n arn:aws:iam::123456789012:saml-metadata/MyUniversity\n \n \n 29f47818-99f5-11e1-a4c3-27EXAMPLE804\n \n\n \n\t\t\n\t" }, "UpdateServerCertificate": { "name": "UpdateServerCertificate", "input": { "shape_name": "UpdateServerCertificateRequest", "type": "structure", "members": { "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the server certificate that you want to update.

\n\t", "required": true }, "NewPath": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The new path for the server certificate. Include this only if you are updating the server\n\t\t\tcertificate's path.

\n\t" }, "NewServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The new name for the server certificate. Include this only if you are updating the server\n\t\t\tcertificate's name.

\n\t" } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Updates the name and/or the path of the specified server certificate.

\n\t\t You should understand the implications of changing a server certificate's path or\n\t\t\tname. For more information, see Managing Server Certificates in Using AWS Identity and Access Management. \n\t\tTo change a server certificate name the requester must have appropriate permissions on\n\t\t\tboth the source object and the target object. For example, to change the name from\n\t\t\tProductionCert to ProdCert, the entity making the request must have permission on\n\t\t\tProductionCert and ProdCert, or must have permission on all (*). For more information about\n\t\t\tpermissions, see Permissions and Policies. \n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateServerCertificate\n&ServerCertificateName=ProdServerCert\n&NewServerCertificateName=ProdServerCertName\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateSigningCertificate": { "name": "UpdateSigningCertificate", "input": { "shape_name": "UpdateSigningCertificateRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the signing certificate belongs to.

\n\t" }, "CertificateId": { "shape_name": "certificateIdType", "type": "string", "min_length": 24, "max_length": 128, "pattern": "[\\w]*", "documentation": "\n\t\t

The ID of the signing certificate you want to update.

\n\t", "required": true }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status you want to assign to the certificate. Active means the certificate\n\t\t\tcan be used for API calls to AWS, while Inactive means the certificate cannot be\n\t\t\tused.

\n\t", "required": true } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" } ], "documentation": "\n\t\t

Changes the status of the specified signing certificate from active to disabled, or vice\n\t\t\tversa. This action can be used to disable a user's signing certificate as part of a\n\t\t\tcertificate rotation work flow.

\n\t\t

If the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.

\n\t\t

For information about rotating certificates, see Managing Keys and Certificates in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateSigningCertificate\n&UserName=Bob\n&CertificateId=TA7SMP42TDN5Z26OBPJE7EXAMPLE\n&Status=Inactive\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UpdateUser": { "name": "UpdateUser", "input": { "shape_name": "UpdateUserRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user to update. If you're changing the name of the user, this is the original\n\t\t\tuser name.

\n\t", "required": true }, "NewPath": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

New path for the user. Include this parameter only if you're changing the user's path.

\n\t" }, "NewUserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

New name for the user. Include this parameter only if you're changing the user's name.

\n\t" } }, "documentation": " " }, "output": null, "errors": [ { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "EntityTemporarilyUnmodifiableException", "type": "structure", "members": { "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.

\n\t" } ], "documentation": "\n\t\t

Updates the name and/or the path of the specified user.

\n\t\t You should understand the implications of changing a user's path or name. For more\n\t\t\tinformation, see Renaming Users and Groups in Using AWS Identity and Access\n\t\t\t\tManagement. \n\t\tTo change a user name the requester must have appropriate permissions on both the source\n\t\t\tobject and the target object. For example, to change Bob to Robert, the entity making the\n\t\t\trequest must have permission on Bob and Robert, or must have permission on all (*). For more\n\t\t\tinformation about permissions, see Permissions and Policies. \n\t\t\n\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UpdateUser\n&UserName=Bob\n&NewUserName=Robert\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n /division_abc/subdivision_xyz/\n Robert\n AIDACKCEVSQ6C2EXAMPLE\n arn:aws::123456789012:user/division_abc/subdivision_xyz/Robert\n \n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UploadServerCertificate": { "name": "UploadServerCertificate", "input": { "shape_name": "UploadServerCertificateRequest", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

The path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\t

This parameter is optional. If it is not included, it defaults to a slash (/).

\n\t" }, "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name for the server certificate. Do not include the path in this value.

\n\t", "required": true }, "CertificateBody": { "shape_name": "certificateBodyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "documentation": "\n\t\t

The contents of the public key certificate in PEM-encoded format.

\n\t", "required": true }, "PrivateKey": { "shape_name": "privateKeyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*", "sensitive": true, "documentation": "\n\t\t

The contents of the private key in PEM-encoded format.

\n\t", "required": true }, "CertificateChain": { "shape_name": "certificateChainType", "type": "string", "min_length": 1, "max_length": 2097152, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*", "documentation": "\n\t\t

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded\n\t\t\tpublic key certificates of the chain.

\n\t" } }, "documentation": " " }, "output": { "shape_name": "UploadServerCertificateResponse", "type": "structure", "members": { "ServerCertificateMetadata": { "shape_name": "ServerCertificateMetadata", "type": "structure", "members": { "Path": { "shape_name": "pathType", "type": "string", "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", "documentation": "\n\t\t

Path to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "ServerCertificateName": { "shape_name": "serverCertificateNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name that identifies the server certificate.

\n\t", "required": true }, "ServerCertificateId": { "shape_name": "idType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the server certificate was uploaded.

\n\t" } }, "documentation": "\n\t\t

The meta information of the uploaded server certificate without its certificate body,\n\t\t\tcertificate chain, and private key.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the UploadServerCertificate\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "MalformedCertificateException", "type": "structure", "members": { "message": { "shape_name": "malformedCertificateMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "KeyPairMismatchException", "type": "structure", "members": { "message": { "shape_name": "keyPairMismatchMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the public key certificate and the private key do not\n\t\t\tmatch.

\n\t" } ], "documentation": "\n\t\t

Uploads a server certificate entity for the AWS account. The server certificate entity\n\t\t\tincludes a public key certificate, a private key, and an optional certificate chain, which\n\t\t\tshould all be PEM-encoded.

\n\t\t

For information about the number of server certificates you can upload, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.

\n\t\tBecause the body of the public key certificate, private key, and the certificate chain can\n\t\t\tbe large, you should use POST rather than GET when calling\n\t\t\t\tUploadServerCertificate. For information about setting up signatures and\n\t\t\tauthorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.\n\t\t\n\t\t\t\nhttps://iam.amazonaws.com/\n?Action=UploadServerCertificate\n&ServerCertificateName=ProdServerCert\n&Path=/company/servercerts/\n&CertificateBody=-----BEGIN CERTIFICATE-----\nMIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\nAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\nGEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\nMDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\nFQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\nMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\ndqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\nywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\nsuDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\nCgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\nCAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\nwr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\nwFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\nAEaHzTpmEXAMPLE=\n-----END CERTIFICATE-----\n&PrivateKey=-----BEGIN DSA PRIVATE KEY-----\nMIIBugIBTTKBgQD33xToSXPJ6hr37L3+KNi3/7DgywlBcvlFPPSHIw3ORuO/22mT\n8Cy5fT89WwNvZ3BPKWU6OZ38TQv3eWjNc/3U3+oqVNG2poX5nCPOtO1b96HYX2mR\n3FTdH6FRKbQEhpDzZ6tRrjTHjMX6sT3JRWkBd2c4bGu+HUHO1H7QvrCTeQIVTKMs\nTCKCyrLiGhUWuUGNJUMU6y6zToGTHl84Tz7TPwDGDXuy/Dk5s4jTVr+xibROC/gS\nQrs4Dzz3T1ze6lvU8S1KT9UsOB5FUJNTTPCPey+Lo4mmK6b23XdTyCIT8e2fsm2j\njHHC1pIPiTkdLS3j6ZYjF8LY6TENFng+LDY/xwPOl7TJVoD3J/WXC2J9CEYq9o34\nkq6WWn3CgYTuo54nXUgnoCb3xdG8COFrg+oTbIkHTSzs3w5o/GGgKK7TDF3UlJjq\nvHNyJQ6kWBrQRR1Xp5KYQ4c/Dm5kef+62mH53HpcCELguWVcffuVQpmq3EWL9Zp9\njobTJQ2VHjb5IVxiO6HRSd27di3njyrzUuJCyHSDTqwLJmTThpd6OTIUTL3Tc4m2\n62TITdw53KWJEXAMPLE=\n-----END DSA PRIVATE KEY-----\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n ProdServerCert\n /company/servercerts/\n arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert\n 2010-05-08T01:02:03.004Z\n ASCACKCEVSQ6C2EXAMPLE\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" }, "UploadSigningCertificate": { "name": "UploadSigningCertificate", "input": { "shape_name": "UploadSigningCertificateRequest", "type": "structure", "members": { "UserName": { "shape_name": "existingUserNameType", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the signing certificate is for.

\n\t" }, "CertificateBody": { "shape_name": "certificateBodyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "documentation": "\n\t\t

The contents of the signing certificate.

\n\t", "required": true } }, "documentation": " " }, "output": { "shape_name": "UploadSigningCertificateResponse", "type": "structure", "members": { "Certificate": { "shape_name": "SigningCertificate", "type": "structure", "members": { "UserName": { "shape_name": "userNameType", "type": "string", "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

Name of the user the signing certificate is associated with.

\n\t", "required": true }, "CertificateId": { "shape_name": "certificateIdType", "type": "string", "min_length": 24, "max_length": 128, "pattern": "[\\w]*", "documentation": "\n\t\t

The ID for the signing certificate.

\n\t", "required": true }, "CertificateBody": { "shape_name": "certificateBodyType", "type": "string", "min_length": 1, "max_length": 16384, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "documentation": "\n\t\t

The contents of the signing certificate.

\n\t", "required": true }, "Status": { "shape_name": "statusType", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\n\t\t

The status of the signing certificate. Active means the key is valid for API\n\t\t\tcalls, while Inactive means it is not.

\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date when the signing certificate was uploaded.

\n\t" } }, "documentation": "\n\t\t

Information about the certificate.

\n\t", "required": true } }, "documentation": "\n\t\t

Contains the result of a successful invocation of the UploadSigningCertificate\n\t\t\taction.

\n\t" }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "limitExceededMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.

\n\t" }, { "shape_name": "EntityAlreadyExistsException", "type": "structure", "members": { "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it attempted to create a resource that already exists.

\n\t" }, { "shape_name": "MalformedCertificateException", "type": "structure", "members": { "message": { "shape_name": "malformedCertificateMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "InvalidCertificateException", "type": "structure", "members": { "message": { "shape_name": "invalidCertificateMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the certificate is invalid.

\n\t" }, { "shape_name": "DuplicateCertificateException", "type": "structure", "members": { "message": { "shape_name": "duplicateCertificateMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because the same certificate is associated to another user under the\n\t\t\taccount.

\n\t" }, { "shape_name": "NoSuchEntityException", "type": "structure", "members": { "message": { "shape_name": "noSuchEntityMessage", "type": "string", "documentation": " " } }, "documentation": "\n\t\t

The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.

\n\t" } ], "documentation": "\n\t\t

Uploads an X.509 signing certificate and associates it with the specified user. Some AWS\n\t\t\tservices use X.509 signing certificates to validate requests that are signed with a\n\t\t\tcorresponding private key. When you upload the certificate, its default status is\n\t\t\t\tActive.

\n\t\t

If the UserName field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.

\n\t\tBecause the body of a X.509 certificate can be large, you should use POST rather than GET\n\t\t\twhen calling UploadSigningCertificate. For information about setting up\n\t\t\tsignatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.\n\t\t\n\t\t\t\nPOST / HTTP/1.1\nHost: iam.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\n\nAction=UploadSigningCertificate\n&UserName=Bob\n&CertificateBody=-----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----\n&Version=2010-05-08\n&AUTHPARAMS\n \n\t\t\t\n\n \n \n Bob\n TA7SMP42TDN5Z26OBPJE7EXAMPLE\n -----BEGIN CERTIFICATE-----\n MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT\n AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT\n GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy\n MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw\n FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf\n MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr\n dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL\n ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf\n suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww\n CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK\n CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH\n wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX\n wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX\n AEaHzTpmEXAMPLE=\n -----END CERTIFICATE-----\n Active\n \n \n \n 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE\n \n\n \n\t\t\n\t" } }, "metadata": { "regions": { "us-east-1": "https://iam.amazonaws.com/", "us-gov-west-1": "https://iam.us-gov.amazonaws.com/", "cn-north-1": "https://iam.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "GetGroup": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Users", "py_input_token": "marker" }, "ListAccessKeys": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "AccessKeyMetadata", "py_input_token": "marker" }, "ListAccountAliases": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "AccountAliases", "py_input_token": "marker" }, "ListGroupPolicies": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" }, "ListGroups": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Groups", "py_input_token": "marker" }, "ListGroupsForUser": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Groups", "py_input_token": "marker" }, "ListInstanceProfiles": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "InstanceProfiles", "py_input_token": "marker" }, "ListInstanceProfilesForRole": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "InstanceProfiles", "py_input_token": "marker" }, "ListMFADevices": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "MFADevices", "py_input_token": "marker" }, "ListRolePolicies": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" }, "ListRoles": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Roles", "py_input_token": "marker" }, "ListServerCertificates": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "ServerCertificateMetadataList", "py_input_token": "marker" }, "ListSigningCertificates": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Certificates", "py_input_token": "marker" }, "ListUserPolicies": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "PolicyNames", "py_input_token": "marker" }, "ListUsers": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "Users", "py_input_token": "marker" }, "ListVirtualMFADevices": { "more_key": "IsTruncated", "input_token": "Marker", "output_token": "Marker", "result_key": "VirtualMFADevices", "py_input_token": "marker" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/importexport.json0000644000175000017500000013427712254746564021733 0ustar takakitakaki{ "api_version": "2010-06-01", "type": "query", "result_wrapped": true, "signature_version": "v2", "service_full_name": "AWS Import/Export", "global_endpoint": "importexport.amazonaws.com", "endpoint_prefix": "importexport", "xmlnamespace": "http://importexport.amazonaws.com/doc/2010-06-01/", "documentation": "\n AWS Import/Export Service\n AWS Import/Export accelerates transferring large amounts of data between\n the AWS cloud and portable storage devices that you mail to us. AWS\n Import/Export transfers data directly onto and off of your storage devices\n using Amazon's high-speed internal network and bypassing the Internet. For\n large data sets, AWS Import/Export is often faster than Internet transfer\n and more cost effective than upgrading your connectivity.\n ", "operations": { "CancelJob": { "name": "CancelJob", "http": { "method": "POST", "uri": "/?Operation=CancelJob" }, "input": { "shape_name": "CancelJobInput", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n ", "required": true } }, "documentation": "\n Input structure for the CancelJob operation.\n " }, "output": { "shape_name": "CancelJobOutput", "type": "structure", "members": { "Success": { "shape_name": "Success", "type": "boolean", "documentation": "\n Specifies whether (true) or not (false) AWS Import/Export updated your job.\n " } }, "documentation": "\n Output structure for the CancelJob operation.\n " }, "errors": [ { "shape_name": "InvalidJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The JOBID was missing, not found, or not associated with the AWS account.\n " }, { "shape_name": "ExpiredJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Indicates that the specified job has expired out of the system.\n " }, { "shape_name": "CanceledJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The specified job ID has been canceled and is no longer valid.\n " }, { "shape_name": "UnableToCancelJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n AWS Import/Export cannot cancel the job\n " }, { "shape_name": "InvalidAccessKeyIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID.\n " } ], "documentation": "\n This operation cancels a specified job. Only the job owner can cancel it.\n The operation fails if the job has already started or is complete.\n " }, "CreateJob": { "name": "CreateJob", "http": { "method": "POST", "uri": "/?Operation=CreateJob" }, "input": { "shape_name": "CreateJobInput", "type": "structure", "members": { "JobType": { "shape_name": "JobType", "type": "string", "enum": [ "Import", "Export" ], "documentation": "\n Specifies whether the job to initiate is an import or export job.\n ", "required": true }, "Manifest": { "shape_name": "Manifest", "type": "string", "documentation": "\n The UTF-8 encoded text of the manifest file.\n ", "required": true }, "ManifestAddendum": { "shape_name": "ManifestAddendum", "type": "string", "documentation": "\n For internal use only.\n " }, "ValidateOnly": { "shape_name": "ValidateOnly", "type": "boolean", "documentation": "\n Validate the manifest and parameter values in the request but do not actually create a job.\n ", "required": true } }, "documentation": "\n Input structure for the CreateJob operation.\n " }, "output": { "shape_name": "CreateJobOutput", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n " }, "JobType": { "shape_name": "JobType", "type": "string", "enum": [ "Import", "Export" ], "documentation": "\n Specifies whether the job to initiate is an import or export job.\n " }, "AwsShippingAddress": { "shape_name": "AwsShippingAddress", "type": "string", "documentation": "\n Address you ship your storage device to.\n " }, "Signature": { "shape_name": "Signature", "type": "string", "documentation": "\n An encrypted code used to authenticate the request and response, for\n example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to\n create the signature file yourself. Generally you should use the\n SignatureFileContents value.\n " }, "SignatureFileContents": { "shape_name": "SignatureFileContents", "type": "string", "documentation": "\n The actual text of the SIGNATURE file to be written to disk.\n " }, "WarningMessage": { "shape_name": "WarningMessage", "type": "string", "documentation": "\n An optional message notifying you of non-fatal issues with the job, such as\n use of an incompatible Amazon S3 bucket name.\n " } }, "documentation": "\n Output structure for the CreateJob operation.\n " }, "errors": [ { "shape_name": "MissingParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required parameters was missing from the request.\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more parameters had an invalid value.\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more parameters had an invalid value.\n " }, { "shape_name": "InvalidAccessKeyIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID.\n " }, { "shape_name": "InvalidAddressException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The address specified in the manifest is invalid.\n " }, { "shape_name": "InvalidManifestFieldException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more manifest fields was invalid. Please correct and resubmit.\n " }, { "shape_name": "MissingManifestFieldException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required fields were missing from the manifest file. Please correct and resubmit.\n " }, { "shape_name": "NoSuchBucketException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The specified bucket does not exist. Create the specified bucket or change\n the manifest's bucket, exportBucket, or logBucket field to a bucket that\n the account, as specified by the manifest's Access Key ID, has write\n permissions to.\n " }, { "shape_name": "MissingCustomsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required customs parameters was missing from the manifest.\n " }, { "shape_name": "InvalidCustomsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more customs parameters was invalid. Please correct and resubmit.\n " }, { "shape_name": "InvalidFileSystemException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n File system specified in export manifest is invalid.\n " }, { "shape_name": "MultipleRegionsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Your manifest file contained buckets from multiple regions. A job is\n restricted to buckets from one region. Please correct and resubmit.\n " }, { "shape_name": "BucketPermissionException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The account specified does not have the appropriate bucket permissions.\n " }, { "shape_name": "MalformedManifestException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Your manifest is not well-formed.\n " } ], "documentation": "\n This operation initiates the process of scheduling an upload or download of\n your data. You include in the request a manifest that describes the data\n transfer specifics. The response to the request includes a job ID, which\n you can use in other operations, a signature that you use to identify your\n storage device, and the address where you should ship your storage device.\n " }, "GetStatus": { "name": "GetStatus", "http": { "method": "POST", "uri": "/?Operation=GetStatus" }, "input": { "shape_name": "GetStatusInput", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n ", "required": true } }, "documentation": "\n Input structure for the GetStatus operation.\n " }, "output": { "shape_name": "GetStatusOutput", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n " }, "JobType": { "shape_name": "JobType", "type": "string", "enum": [ "Import", "Export" ], "documentation": "\n Specifies whether the job to initiate is an import or export job.\n " }, "AwsShippingAddress": { "shape_name": "AwsShippingAddress", "type": "string", "documentation": "\n Address you ship your storage device to.\n " }, "LocationCode": { "shape_name": "LocationCode", "type": "string", "documentation": "\n A token representing the location of the storage device, such as \"AtAWS\".\n " }, "LocationMessage": { "shape_name": "LocationMessage", "type": "string", "documentation": "\n A more human readable form of the physical location of the storage device.\n " }, "ProgressCode": { "shape_name": "ProgressCode", "type": "string", "documentation": "\n A token representing the state of the job, such as \"Started\".\n " }, "ProgressMessage": { "shape_name": "ProgressMessage", "type": "string", "documentation": "\n A more human readable form of the job status.\n " }, "Carrier": { "shape_name": "Carrier", "type": "string", "documentation": "\n Name of the shipping company. This value is included when the LocationCode is \"Returned\".\n " }, "TrackingNumber": { "shape_name": "TrackingNumber", "type": "string", "documentation": "\n The shipping tracking number assigned by AWS Import/Export to the storage\n device when it's returned to you. We return this value when the\n LocationCode is \"Returned\".\n " }, "LogBucket": { "shape_name": "LogBucket", "type": "string", "documentation": "\n Amazon S3 bucket for user logs.\n " }, "LogKey": { "shape_name": "LogKey", "type": "string", "documentation": "\n The key where the user logs were stored.\n " }, "ErrorCount": { "shape_name": "ErrorCount", "type": "integer", "documentation": "\n Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors.\n " }, "Signature": { "shape_name": "Signature", "type": "string", "documentation": "\n An encrypted code used to authenticate the request and response, for\n example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to\n create the signature file yourself. Generally you should use the\n SignatureFileContents value.\n " }, "SignatureFileContents": { "shape_name": "Signature", "type": "string", "documentation": "\n An encrypted code used to authenticate the request and response, for\n example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to\n create the signature file yourself. Generally you should use the\n SignatureFileContents value.\n " }, "CurrentManifest": { "shape_name": "CurrentManifest", "type": "string", "documentation": "\n The last manifest submitted, which will be used to process the job.\n " }, "CreationDate": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\".\n " } }, "documentation": "\n Output structure for the GetStatus operation.\n " }, "errors": [ { "shape_name": "InvalidJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The JOBID was missing, not found, or not associated with the AWS account.\n " }, { "shape_name": "ExpiredJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Indicates that the specified job has expired out of the system.\n " }, { "shape_name": "CanceledJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The specified job ID has been canceled and is no longer valid.\n " }, { "shape_name": "InvalidAccessKeyIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID.\n " } ], "documentation": "\n This operation returns information about a job, including where the job is\n in the processing pipeline, the status of the results, and the signature\n value associated with the job. You can only return information about jobs\n you own.\n " }, "ListJobs": { "name": "ListJobs", "http": { "method": "POST", "uri": "/?Operation=ListJobs" }, "input": { "shape_name": "ListJobsInput", "type": "structure", "members": { "MaxJobs": { "shape_name": "MaxJobs", "type": "integer", "documentation": "\n Sets the maximum number of jobs returned in the response. If there are\n additional jobs that were not returned because MaxJobs was exceeded, the\n response contains <IsTruncated>true</IsTruncated>. To return\n the additional jobs, see Marker.\n " }, "Marker": { "shape_name": "Marker", "type": "string", "documentation": "\n Specifies the JOBID to start after when listing the jobs created with your\n account. AWS Import/Export lists your jobs in reverse chronological order.\n See MaxJobs.\n " } }, "documentation": "\n Input structure for the ListJobs operation.\n " }, "output": { "shape_name": "ListJobsOutput", "type": "structure", "members": { "Jobs": { "shape_name": "JobsList", "type": "list", "members": { "shape_name": "Job", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n " }, "CreationDate": { "shape_name": "CreationDate", "type": "timestamp", "documentation": "\n Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\".\n " }, "IsCanceled": { "shape_name": "IsCanceled", "type": "boolean", "documentation": "\n Indicates whether the job was canceled.\n " }, "JobType": { "shape_name": "JobType", "type": "string", "enum": [ "Import", "Export" ], "documentation": "\n Specifies whether the job to initiate is an import or export job.\n " } }, "documentation": "\n Representation of a job returned by the ListJobs operation.\n " }, "documentation": "\n A list container for Jobs returned by the ListJobs operation.\n " }, "IsTruncated": { "shape_name": "IsTruncated", "type": "boolean", "documentation": "\n Indicates whether the list of jobs was truncated. If true, then call\n ListJobs again using the last JobId element as the marker.\n " } }, "documentation": "\n Output structure for the ListJobs operation.\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more parameters had an invalid value.\n " }, { "shape_name": "InvalidAccessKeyIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID.\n " } ], "documentation": "\n This operation returns the jobs associated with the requester. AWS\n Import/Export lists the jobs in reverse chronological order based on the\n date of creation. For example if Job Test1 was created 2009Dec30 and Test2\n was created 2010Feb05, the ListJobs operation would return Test2 followed\n by Test1.\n " }, "UpdateJob": { "name": "UpdateJob", "http": { "method": "POST", "uri": "/?Operation=UpdateJob" }, "input": { "shape_name": "UpdateJobInput", "type": "structure", "members": { "JobId": { "shape_name": "JobId", "type": "string", "documentation": "\n A unique identifier which refers to a particular job.\n ", "required": true }, "Manifest": { "shape_name": "Manifest", "type": "string", "documentation": "\n The UTF-8 encoded text of the manifest file.\n ", "required": true }, "JobType": { "shape_name": "JobType", "type": "string", "enum": [ "Import", "Export" ], "documentation": "\n Specifies whether the job to initiate is an import or export job.\n ", "required": true }, "ValidateOnly": { "shape_name": "ValidateOnly", "type": "boolean", "documentation": "\n Validate the manifest and parameter values in the request but do not actually create a job.\n ", "required": true } }, "documentation": "\n Input structure for the UpateJob operation.\n " }, "output": { "shape_name": "UpdateJobOutput", "type": "structure", "members": { "Success": { "shape_name": "Success", "type": "boolean", "documentation": "\n Specifies whether (true) or not (false) AWS Import/Export updated your job.\n " }, "WarningMessage": { "shape_name": "WarningMessage", "type": "string", "documentation": "\n An optional message notifying you of non-fatal issues with the job, such as\n use of an incompatible Amazon S3 bucket name.\n " } }, "documentation": "\n Output structure for the UpateJob operation.\n " }, "errors": [ { "shape_name": "MissingParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required parameters was missing from the request.\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more parameters had an invalid value.\n " }, { "shape_name": "InvalidAccessKeyIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The AWS Access Key ID specified in the request did not match the manifest's\n accessKeyId value. The manifest and the request authentication must use the\n same AWS Access Key ID.\n " }, { "shape_name": "InvalidAddressException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The address specified in the manifest is invalid.\n " }, { "shape_name": "InvalidManifestFieldException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more manifest fields was invalid. Please correct and resubmit.\n " }, { "shape_name": "InvalidJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The JOBID was missing, not found, or not associated with the AWS account.\n " }, { "shape_name": "MissingManifestFieldException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required fields were missing from the manifest file. Please correct and resubmit.\n " }, { "shape_name": "NoSuchBucketException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The specified bucket does not exist. Create the specified bucket or change\n the manifest's bucket, exportBucket, or logBucket field to a bucket that\n the account, as specified by the manifest's Access Key ID, has write\n permissions to.\n " }, { "shape_name": "ExpiredJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Indicates that the specified job has expired out of the system.\n " }, { "shape_name": "CanceledJobIdException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The specified job ID has been canceled and is no longer valid.\n " }, { "shape_name": "MissingCustomsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more required customs parameters was missing from the manifest.\n " }, { "shape_name": "InvalidCustomsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n One or more customs parameters was invalid. Please correct and resubmit.\n " }, { "shape_name": "InvalidFileSystemException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n File system specified in export manifest is invalid.\n " }, { "shape_name": "MultipleRegionsException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Your manifest file contained buckets from multiple regions. A job is\n restricted to buckets from one region. Please correct and resubmit.\n " }, { "shape_name": "BucketPermissionException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n The account specified does not have the appropriate bucket permissions.\n " }, { "shape_name": "MalformedManifestException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n The human-readable description of a particular error.\n " } }, "documentation": "\n Your manifest is not well-formed.\n " } ], "documentation": "\n You use this operation to change the parameters specified in the original\n manifest file by supplying a new manifest file. The manifest file attached\n to this request replaces the original manifest file. You can only use the\n operation after a CreateJob request but before the data transfer starts and\n you can only use it on jobs you own.\n " } }, "metadata": { "regions": { "us-east-1": "https://importexport.amazonaws.com" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/kinesis.json0000644000175000017500000023525112254746564020616 0ustar takakitakaki{ "api_version": "2013-12-02", "type": "json", "json_version": 1.1, "target_prefix": "Kinesis_20131202", "signature_version": "v4", "service_full_name": "Amazon Kinesis", "service_abbreviation": "Kinesis", "endpoint_prefix": "kinesis", "xmlnamespace": "http://kinesis.amazonaws.com/doc/2013-12-02", "documentation": "\n Amazon Kinesis Service API Reference\n

Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.

\n ", "operations": { "CreateStream": { "name": "CreateStream", "input": { "shape_name": "CreateStreamInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream.\n It is also scoped by region. That is, two streams in two different AWS accounts can have the same name,\n and two streams in the same AWS account, but in two different regions, can have the same name.

\n ", "required": true }, "ShardCount": { "shape_name": "PositiveIntegerObject", "type": "integer", "min_length": 1, "documentation": "\n

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater\n provisioned throughput.

\n

Note: The default limit for an AWS account is two shards per stream. \n If you need to create a stream with more than two shards, contact AWS Support to increase the limit on your account.

\n ", "required": true } }, "documentation": "\n

Represents the input of a CreateStream operation.

\n " }, "output": null, "errors": [ { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation adds a new Amazon Kinesis stream to your AWS account. A stream captures and transports data records that are continuously emitted from different data sources or producers. \n\t Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.

\n\t

You specify and control the number of shards that a stream is composed of. Each shard can support up to 5 read transactions per second up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 write transactions per second up to a maximum total of 1 MB data written per second. \n\t You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.

\n\t

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. \n\t That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.

\n\t

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, \n\t Amazon Kinesis immediately returns and sets the stream status to CREATING. After the stream is created, Amazon Kinesis sets the stream status to ACTIVE. \n\t You should perform read and write operations only on an ACTIVE stream.

\n\t

You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:

\n\t \n\t

Note: The default limit for an AWS account is two shards per stream. \n\t If you need to create a stream with more than two shards, contact AWS Support to increase the limit on your account.

\n\t

You can use the DescribeStream operation to check the stream status, which is returned in StreamStatus.

\n\t

CreateStream has a limit of 5 transactions per second per account.

\n\t \n\t \n\t Create a Stream \n\t The following is an example of an Amazon Kinesis CreateStream request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.CreateStream \n\n{\n \"StreamName\":\"exampleStreamName\",\"ShardCount\":3\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\t \n\t \n\t \n " }, "DeleteStream": { "name": "DeleteStream", "input": { "shape_name": "DeleteStreamInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream to delete.

\n ", "required": true } }, "documentation": "\n

Represents the input of a DeleteStream operation.

\n " }, "output": null, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation deletes a stream and all of its shards and data. \n\t You must shut down any applications that are operating on the stream before you delete the stream. \n\t If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException.

\n\t

If the stream is in the ACTIVE state, you can delete it. \n\t After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

\n\t

Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord and GetRecords, \n\t on a stream in the DELETING state until the stream deletion is complete.

\n\t

When you delete a stream, any shards in that stream are also deleted.

\n\t

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

\n\t

DeleteStream has a limit of 5 transactions per second per account.

\n\t \n\t \n\t Delete a Stream \n\t The following is an example of an Amazon Kinesis DeleteStream request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.DeleteStream\n\n{\n \"StreamName\":\"exampleStreamName\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\t \n\t \n\t \n " }, "DescribeStream": { "name": "DescribeStream", "input": { "shape_name": "DescribeStreamInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream to describe.

\n ", "required": true }, "Limit": { "shape_name": "DescribeStreamInputLimit", "type": "integer", "min_length": 1, "max_length": 10000, "documentation": "\n

The maximum number of shards to return.

\n " }, "ExclusiveStartShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the shard to start with for the stream description.

\n " } }, "documentation": "\n

Represents the input of a DescribeStream operation.

\n " }, "output": { "shape_name": "DescribeStreamOutput", "type": "structure", "members": { "StreamDescription": { "shape_name": "StreamDescription", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream being described.

\n ", "required": true }, "StreamARN": { "shape_name": "StreamARN", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for the stream being described.

\n ", "required": true }, "StreamStatus": { "shape_name": "StreamStatus", "type": "string", "enum": [ "CREATING", "DELETING", "ACTIVE", "UPDATING" ], "documentation": "\n

The current status of the stream being described.

\n

The stream status is one of the following states:

\n \n ", "required": true }, "Shards": { "shape_name": "ShardList", "type": "list", "members": { "shape_name": "Shard", "type": "structure", "members": { "ShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The unique identifier of the shard within the Amazon Kinesis stream.

\n ", "required": true }, "ParentShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard Id of the shard's parent.

\n " }, "AdjacentParentShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard Id of the shard adjacent to the shard's parent.

\n " }, "HashKeyRange": { "shape_name": "HashKeyRange", "type": "structure", "members": { "StartingHashKey": { "shape_name": "HashKey", "type": "string", "pattern": "0|([1-9]\\d{0,38})", "documentation": "\n

The starting hash key of the hash key range.

\n ", "required": true }, "EndingHashKey": { "shape_name": "HashKey", "type": "string", "pattern": "0|([1-9]\\d{0,38})", "documentation": "\n

The ending hash key of the hash key range.

\n ", "required": true } }, "documentation": "\n

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

\n ", "required": true }, "SequenceNumberRange": { "shape_name": "SequenceNumberRange", "type": "structure", "members": { "StartingSequenceNumber": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The starting sequence number for the range.

\n ", "required": true }, "EndingSequenceNumber": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

\n " } }, "documentation": "\n

The range of possible sequence numbers for the shard.

\n ", "required": true } }, "documentation": "\n

A uniquely identified group of data records in an Amazon Kinesis stream.

\n " }, "documentation": "\n

The shards that comprise the stream.

\n ", "required": true }, "HasMoreShards": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

If set to true there are more shards in the stream available to describe.

\n ", "required": true } }, "documentation": " \n

Contains the current status of the stream, the stream ARN, an array of shard objects that comprise the stream, \n and states whether there are more shards available.

\n ", "required": true } }, "documentation": " \n

Represents the output of a DescribeStream operation.

\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation returns the following information about the stream: the current status of the stream, the stream Amazon Resource Name (ARN), \n\t and an array of shard objects that comprise the stream. For each shard object there is information about the hash key and sequence number ranges that the shard spans, \n\t and the IDs of any earlier shards that played in a role in a MergeShards or SplitShard operation that created the shard. \n\t A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. \n\t The sequence number is assigned by the Amazon Kinesis service when a record is put into the stream.

\n\t

You can limit the number of returned shards using the Limit parameter. \n\t The number of shards in a stream may be too large to return from a single call to DescribeStream. \n\t You can detect this by using the HasMoreShards flag in the returned output. \n\t HasMoreShards is set to true when there is more data available. \n\t

\n\t

If there are more shards available, you can request more shards by using the shard ID of the last shard returned by the DescribeStream \n\t request, in the ExclusiveStartShardId parameter in a subsequent request to DescribeStream. \n\t DescribeStream is a paginated operation. \n\t

\n\t

DescribeStream has a limit of 10 transactions per second per account.

\n\t \n\t \n\t Obtain Information About a Stream \n\t The following is an example of an Amazon Kinesis DescribeStream request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.DescribeStream\n{\n \"StreamName\":\"exampleStreamName\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\n\n{\n \"StreamDescription\": {\n \"HasMoreShards\": false,\n \"Shards\": [\n {\n \"HashKeyRange\": {\n \"EndingHashKey\": \"113427455640312821154458202477256070484\",\n \"StartingHashKey\": \"0\"\n },\n \"SequenceNumberRange\": {\n \"EndingSequenceNumber\": \"21269319989741826081360214168359141376\",\n \"StartingSequenceNumber\": \"21267647932558653966460912964485513216\"\n },\n \"ShardId\": \"shardId-000000000000\"\n },\n {\n \"HashKeyRange\": {\n \"EndingHashKey\": \"226854911280625642308916404954512140969\",\n \"StartingHashKey\": \"113427455640312821154458202477256070485\"\n },\n \"SequenceNumberRange\": {\n \"StartingSequenceNumber\": \"21267647932558653966460912964485513217\"\n },\n \"ShardId\": \"shardId-000000000001\"\n },\n {\n \"HashKeyRange\": {\n \"EndingHashKey\": \"340282366920938463463374607431768211455\",\n \"StartingHashKey\": \"226854911280625642308916404954512140970\"\n },\n \"SequenceNumberRange\": {\n \"StartingSequenceNumber\": \"21267647932558653966460912964485513218\"\n },\n \"ShardId\": \"shardId-000000000002\"\n }\n ],\n \"StreamARN\": \"arn:aws:kinesis:us-east-1:052958737983:exampleStreamName\",\n \"StreamName\": \"exampleStreamName\",\n \"StreamStatus\": \"ACTIVE\"\n }\n}\n\t \n\t \n\t \n " }, "GetRecords": { "name": "GetRecords", "input": { "shape_name": "GetRecordsInput", "type": "structure", "members": { "ShardIterator": { "shape_name": "ShardIterator", "type": "string", "min_length": 1, "max_length": 512, "documentation": "\n

The position in the shard from which you want to start sequentially reading data records.

\n ", "required": true }, "Limit": { "shape_name": "GetRecordsInputLimit", "type": "integer", "min_length": 1, "max_length": 10000, "documentation": "\n

The maximum number of records to return, which can be set to a value of up to 10,000.

\n " } }, "documentation": "\n

Represents the input of a GetRecords operation.

\n " }, "output": { "shape_name": "GetRecordsOutput", "type": "structure", "members": { "Records": { "shape_name": "RecordList", "type": "list", "members": { "shape_name": "Record", "type": "structure", "members": { "SequenceNumber": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The unique identifier for the record in the Amazon Kinesis stream.

\n ", "required": true }, "Data": { "shape_name": "Data", "type": "blob", "min_length": 0, "max_length": 51200, "documentation": "\n

The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, \n which does not inspect, interpret, or change the data in the blob in any way. The maximum size of the data blob is 50 kilobytes (KB).

\n ", "required": true }, "PartitionKey": { "shape_name": "PartitionKey", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

Identifies which shard in the stream the data record is assigned to.

\n ", "required": true } }, "documentation": "\n

The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.

\n " }, "documentation": "\n

The data records retrieved from the shard.

\n ", "required": true }, "NextShardIterator": { "shape_name": "ShardIterator", "type": "string", "min_length": 1, "max_length": 512, "documentation": "\n

The next position in the shard from which to start sequentially reading data records.\n If set to null, the shard has been closed and the requested iterator will not return any more data. \n

\n " } }, "documentation": "\n

Represents the output of a GetRecords operation.

\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ExpiredIteratorException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation returns one or more data records from a shard. A GetRecords operation request can retrieve up to 10 MB of data.

\n\t

You specify a shard iterator for the shard that you want to read data from in the ShardIterator parameter. \n\t The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. \n\t A shard iterator specifies this position using the sequence number of a data record in the shard. \n\t For more information about the shard iterator, see GetShardIterator.

\n\t

GetRecords may return a partial result if the response size limit is exceeded. \n\t You will get an error, but not a partial result if the shard's provisioned throughput is exceeded, the shard iterator has expired, \n\t or an internal processing failure has occurred. \n\t Clients can request a smaller amount of data by specifying a maximum number of returned records using the Limit parameter. \n\t The Limit parameter can be set to an integer value of up to 10,000. \n\t If you set the value to an integer greater than 10,000, you will receive InvalidArgumentException.

\n\t

A new shard iterator is returned by every GetRecords request in NextShardIterator, \n\t which you use in the ShardIterator parameter of the next GetRecords request. \n\t When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator to \n\t use in your first GetRecords request and then use the shard iterator returned in NextShardIterator for subsequent reads.

\n\t

GetRecords can return null for the NextShardIterator to reflect that the shard has been closed \n\t and that the requested shard iterator would never have returned more data.

\n\t

If no items can be processed because of insufficient provisioned throughput on the shard involved in the request, \n\t GetRecords throws ProvisionedThroughputExceededException.

\n\t \n\t \n\t Get Data from the Shards in a Stream\n\t The following is an example of an Amazon Kinesis GetRecords request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.GetRecords\n\n{\n \"ShardIterator\": \"AAAAAAAAAAETYyAYzd665+8e0X7JTsASDM/Hr2rSwc0X2qz93iuA3udrjTH+ikQvpQk/1ZcMMLzRdAesqwBGPnsthzU0/CBlM/U8/8oEqGwX3pKw0XyeDNRAAZyXBo3MqkQtCpXhr942BRTjvWKhFz7OmCb2Ncfr8Tl2cBktooi6kJhr+djN5WYkB38Rr3akRgCl9qaU4dY=\",\n \"Limit\": 2\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\n\n{\n \"NextShardIterator\": \"AAAAAAAAAAHsW8zCWf9164uy8Epue6WS3w6wmj4a4USt+CNvMd6uXQ+HL5vAJMznqqC0DLKsIjuoiTi1BpT6nW0LN2M2D56zM5H8anHm30Gbri9ua+qaGgj+3XTyvbhpERfrezgLHbPB/rIcVpykJbaSj5tmcXYRmFnqZBEyHwtZYFmh6hvWVFkIwLuMZLMrpWhG5r5hzkE=\",\n \"Records\": [\n {\n \"Data\": \"XzxkYXRhPl8w\",\n \"PartitionKey\": \"partitionKey\",\n \"SequenceNumber\": \"21269319989652663814458848515492872193\"\n }\n ] \n}\n\t \n\t \n\t \n " }, "GetShardIterator": { "name": "GetShardIterator", "input": { "shape_name": "GetShardIteratorInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream.

\n ", "required": true }, "ShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the shard to get the iterator for.

\n ", "required": true }, "ShardIteratorType": { "shape_name": "ShardIteratorType", "type": "string", "enum": [ "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "TRIM_HORIZON", "LATEST" ], "documentation": "\n

Determines how the shard iterator is used to start reading data records from the shard.

\n

The following are the valid shard iterator types:

\n \n ", "required": true }, "StartingSequenceNumber": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The sequence number of the data record in the shard from which to start reading from.

\n " } }, "documentation": "\n

Represents the input of a GetShardIterator operation.

\n " }, "output": { "shape_name": "GetShardIteratorOutput", "type": "structure", "members": { "ShardIterator": { "shape_name": "ShardIterator", "type": "string", "min_length": 1, "max_length": 512, "documentation": "\n

The position in the shard from which to start reading data records sequentially. \n A shard iterator specifies this position using the sequence number of a data record in a shard.

\n " } }, "documentation": "\n

Represents the output of a GetShardIterator operation.

\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation returns a shard iterator in ShardIterator. The shard iterator specifies the position in the shard from \n\t which you want to start reading data records sequentially. \n\t A shard iterator specifies this position using the sequence number of a data record in a shard. \n\t A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. \n\t The sequence number is assigned by the Amazon Kinesis service when a record is put into the stream.

\n\t

You must specify the shard iterator type in the GetShardIterator request. \n\t For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number \n\t by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, \n\t using sequence numbers returned by earlier PutRecord, GetRecords or DescribeStream requests. \n\t You can specify the shard iterator type TRIM_HORIZON in the request to cause ShardIterator \n\t to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. \n\t Or you can point to just after the most recent record in the shard, by using the shard iterator type LATEST, so that you always \n\t read the most recent data in the shard.

\n\t

Note: Each shard iterator expires five minutes after it is returned to the requester.

\n\t

When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator request to get the first shard iterator to \n\t to use in your first GetRecords request and then use the shard iterator returned by the \n\t GetRecords request in NextShardIterator for subsequent reads.\n\t A new shard iterator is returned by every GetRecords request in NextShardIterator, \n\t which you use in the ShardIterator parameter of the next GetRecords request.

\n\t

If a GetShardIterator request is made too often, you will receive a ProvisionedThroughputExceededException. \n\t For more information about throughput limits, see the Amazon Kinesis Developer Guide.

\n\t

GetShardIterator can return null for its ShardIterator to indicate that the shard has been closed \n\t and that the requested iterator will return no more data. A shard can be closed by a SplitShard or MergeShards operation.

\n\t

GetShardIterator has a limit of 5 transactions per second per account per shard.

\n\t \n\t \n\t Get a Shard Iterator\n\t The following is an example of an Amazon Kinesis GetShardIterator request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.GetShardIterator\n\n{\n \"StreamName\": \"exampleStreamName\",\n \"ShardId\": \"shardId-000000000001\",\n \"ShardIteratorType\": \"LATEST\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\n{\n \"ShardIterator\": \"AAAAAAAAAAETYyAYzd665+8e0X7JTsASDM/Hr2rSwc0X2qz93iuA3udrjTH+ikQvpQk/1ZcMMLzRdAesqwBGPnsthzU0/CBlM/U8/8oEqGwX3pKw0XyeDNRAAZyXBo3MqkQtCpXhr942BRTjvWKhFz7OmCb2Ncfr8Tl2cBktooi6kJhr+djN5WYkB38Rr3akRgCl9qaU4dY=\" \n}\n\t \n\t \n\t \n " }, "ListStreams": { "name": "ListStreams", "input": { "shape_name": "ListStreamsInput", "type": "structure", "members": { "Limit": { "shape_name": "ListStreamsInputLimit", "type": "integer", "min_length": 1, "max_length": 10000, "documentation": "\n

The maximum number of streams to list.

\n " }, "ExclusiveStartStreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream to start the list with.

\n " } }, "documentation": "\n

Represents the input of a ListStreams operation.

\n " }, "output": { "shape_name": "ListStreamsOutput", "type": "structure", "members": { "StreamNames": { "shape_name": "StreamNameList", "type": "list", "members": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": null }, "documentation": "\n

The names of the streams that are associated with the AWS account making the ListStreams request.

\n ", "required": true }, "HasMoreStreams": { "shape_name": "BooleanObject", "type": "boolean", "documentation": "\n

If set to true, there are more streams available to list.

\n ", "required": true } }, "documentation": "\n

Represents the output of a ListStreams operation.

\n " }, "errors": [ { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation returns an array of the names of all the streams that are associated with the AWS account \n\t making the ListStreams request. A given AWS account can have many streams active at one time. \n\t

\n\t

The number of streams may be too large to return from a single call to ListStreams. \n\t You can limit the number of returned streams using the Limit parameter. \n\t If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.

\n\t

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. \n\t If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams \n\t request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. \n\t The group of stream names returned by the subsequent request is then added to the list. \n\t You can continue this process until all the stream names have been collected in the list.

\n\t

ListStreams has a limit of 5 transactions per second per account.

\n\t \n\t \n\t List the Streams for an AWS Account\n\t The following is an example of an Amazon Kinesis ListStreams request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.ListStreams\n\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\n\n{\n \"HasMoreStreams\": false,\n \"StreamNames\": [\n \"exampleStreamName\"\n ]\n}\n\t \n\t \n\t \n " }, "MergeShards": { "name": "MergeShards", "input": { "shape_name": "MergeShardsInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream for the merge.

\n ", "required": true }, "ShardToMerge": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the shard to combine with the adjacent shard for the merge.

\n ", "required": true }, "AdjacentShardToMerge": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the adjacent shard for the merge.

\n ", "required": true } }, "documentation": "\n

Represents the input of a MergeShards operation.

\n " }, "output": null, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n \t

This operation merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. \n\t Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. \n\t For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, \n\t then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the\n\t merge, the single child shard receives data for all hash key values covered by the two parent shards.

\n\t

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity \n\t that is not being used. \n\t The operation requires that you specify the shard to be merged and the adjacent shard for a given stream. \n\t For more information about merging shards, see the Amazon Kinesis Developer Guide.

\n\t

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in CREATING or UPDATING or DELETING states, \n\t then Amazon Kinesis returns a ResourceInUseException. \n\t If the specified stream does not exist, Amazon Kinesis returns a ResourceNotFoundException.

\n\t

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

\n\t

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, \n\t Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING. \n\t After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE. \n\t Read and write operations continue to work while the stream is in the UPDATING state.

\n\t

You use the DescribeStream operation to determine the shard IDs that are specified in the MergeShards request.

\n\t

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, \n\t MergeShards or SplitShard, you will receive a LimitExceededException.

\n\t

MergeShards has limit of 5 transactions per second per account.

\n\t \n\t \n\t Merge Two Adjacent Shards\n\t The following is an example of an Amazon Kinesis MergeShards request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.MergeShards\n\n{\n \"StreamName\": \"exampleStreamName\",\n \"ShardToMerge\": \"shardId-000000000000\",\n \"AdjacentShardToMerge\": \"shardId-000000000001\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\t \n\t \n\t \n " }, "PutRecord": { "name": "PutRecord", "input": { "shape_name": "PutRecordInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream to put the data record into.

\n ", "required": true }, "Data": { "shape_name": "Data", "type": "blob", "min_length": 0, "max_length": 51200, "documentation": "\n

The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).

\n ", "required": true }, "PartitionKey": { "shape_name": "PartitionKey", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

Determines which shard in the stream the data record is assigned to. \n Partition keys are Unicode strings with a maximum length limit of 256 bytes. \n Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. \n Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. \n As a result of this hashing mechanism, all data records with the same partition key will map to the same shard within the stream.

\n ", "required": true }, "ExplicitHashKey": { "shape_name": "HashKey", "type": "string", "pattern": "0|([1-9]\\d{0,38})", "documentation": "\n

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

\n " }, "SequenceNumberForOrdering": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.

\n " } }, "documentation": "\n

Represents the input of a PutRecord operation.

\n " }, "output": { "shape_name": "PutRecordOutput", "type": "structure", "members": { "ShardId": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the shard where the data record was placed.

\n ", "required": true }, "SequenceNumber": { "shape_name": "SequenceNumber", "type": "string", "pattern": "0|([1-9]\\d{0,128})", "documentation": "\n

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across \n all records in the stream. A sequence number is the identifier associated with every record put into the stream.

\n ", "required": true } }, "documentation": "\n

Represents the output of a PutRecord operation.

\n " }, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ProvisionedThroughputExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n\t

This operation puts a data record into an Amazon Kinesis stream from a producer. \n\t This operation must be called to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing. \n\t The PutRecord operation requires the name of the stream that captures, stores, and transports the data; a partition key; \n\t and the data blob itself. The data blob could be a segment from a log file, geographic/location data, website clickstream data, \n\t or any other data type.

\n\t

The partition key is used to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, \n\t using the partition key associated with each data record to determine which shard a given data record belongs to.

\n\t

Partition keys are Unicode strings, with a maximum length limit of 256 bytes. An MD5 hash function is used to map partition keys to 128-bit \n\t integer values and to map associated data records to shards using the hash key ranges of the shards. \n\t You can override hashing the partition key to determine the shard by explicitly specifying a hash value \n\t using the ExplicitHashKey parameter. For more information, see the \n\t Amazon Kinesis Developer Guide.

\n\t

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

\n\t

The SequenceNumberForOrdering sets the initial sequence number for the partition key. Later PutRecord requests to the same partition key (from the same client) will automatically increase from SequenceNumberForOrdering, ensuring strict sequential ordering.

\n\t

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, \n\t PutRecord throws ProvisionedThroughputExceededException.

\n\t

Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.

\n\t \n\t \n\t Add Data to a Stream \n\t The following is an example of an Amazon Kinesis PutRecord request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.PutRecord\n\n{\n \"StreamName\": \"exampleStreamName\",\n \"Data\": \"XzxkYXRhPl8x\",\n \"PartitionKey\": \"partitionKey\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\n{\n \"SequenceNumber\": \"21269319989653637946712965403778482177\",\n \"ShardId\": \"shardId-000000000001\"\n}\n\t \n\t \n\t \n " }, "SplitShard": { "name": "SplitShard", "input": { "shape_name": "SplitShardInput", "type": "structure", "members": { "StreamName": { "shape_name": "StreamName", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The name of the stream for the shard split.

\n ", "required": true }, "ShardToSplit": { "shape_name": "ShardId", "type": "string", "min_length": 1, "max_length": 128, "pattern": "[a-zA-Z0-9_.-]+", "documentation": "\n

The shard ID of the shard to split.

\n ", "required": true }, "NewStartingHashKey": { "shape_name": "HashKey", "type": "string", "pattern": "0|([1-9]\\d{0,38})", "documentation": "\n

A hash key value for the starting hash key of one of the child shards created by the split. \n The hash key range for a given shard constitutes a set of ordered contiguous positive integers. \n The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. \n The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. \n All the lower hash key values in the range are distributed to the other child shard.

\n ", "required": true } }, "documentation": "\n

Represents the input of a SplitShard operation.

\n " }, "output": null, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "ResourceInUseException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "InvalidArgumentException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " }, { "shape_name": "LimitExceededException", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": " \n " } }, "documentation": " \n " } ], "documentation": "\n\t

This operation splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. \n\t SplitShard is called when there is a need to increase the overall capacity of stream because of an expected increase \n\t in the volume of data records being ingested.

\n\t

SplitShard can also be used when a given shard appears to be approaching its maximum utilization, for example, \n\t when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. \n\t You can also call the SplitShard operation to increase stream capacity, so that more\n\t Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.

\n\t

The SplitShard operation requires that you specify the shard to be split and the new hash key, \n\t which is the position in the shard where the shard gets split in two. \n\t In many cases, the new hash key might simply be the average of the beginning and ending hash key, \n\t but it can be any hash key value in the range being mapped into the shard. \n\t For more information about splitting shards, see the Amazon Kinesis Developer Guide.\n\t

\n\t

You can use the DescribeStream operation to determine the shard ID and hash key values for the \n\t ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

\n\t

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis \n\t immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis \n\t sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state. \n\t

\n\t

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. \n\t If the stream is in the ACTIVE state, you can call SplitShard. \n\t If a stream is in CREATING or UPDATING or DELETING states, then Amazon Kinesis returns a ResourceInUseException.

\n\t

If the specified stream does not exist, Amazon Kinesis returns a ResourceNotFoundException. \n\t If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

\n\t

Note: The default limit for an AWS account is two shards per stream. \n\t If you need to create a stream with more than two shards, contact AWS Support to increase the limit on your account.

\n\t

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, \n\t you will receive a LimitExceededException.

\n\t

SplitShard has limit of 5 transactions per second per account.

\n\t \n\t \n\t Split a Shard \n\t The following is an example of an Amazon Kinesis SplitShard request and response.\n\t .\nx-amz-Date: \nAuthorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=\nUser-Agent: \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nConnection: Keep-Alive]]>\nX-Amz-Target: Kinesis_20131202.SplitShard\n\n{\n \"StreamName\": \"exampleStreamName\",\n \"ShardToSplit\": \"shardId-000000000000\",\n \"NewStartingHashKey\": \"10\"\n}\n\t \n\t \nContent-Type: application/x-amz-json-1.1\nContent-Length: \nDate: ]]>\n\t \n\t \n\t \n " } }, "metadata": { "regions": { "us-east-1": "https://kinesis.amazonaws.com" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/opsworks.json0000644000175000017500000136302012254746564021035 0ustar takakitakaki{ "api_version": "2013-02-18", "type": "json", "json_version": 1.1, "target_prefix": "OpsWorks_20130218", "signature_version": "v4", "service_full_name": "AWS OpsWorks", "endpoint_prefix": "opsworks", "xmlnamespace": "http://opsworks.amazonaws.com/doc/2013-02-18/", "documentation": "\n AWS OpsWorks \n

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks\n actions and data types, including common parameters and error codes.

\n

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the\n complete application lifecycle. For information about this product, go to the\n AWS OpsWorks details page.

\n\n

SDKs and CLI

\n

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or\n by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

\n \n \n

Endpoints

\n

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API\n to direct AWS OpsWorks to create stacks in any AWS Region.

\n

Chef Version

\n

When you call CreateStack, CloneStack, or UpdateStack we recommend you use\n the ConfigurationManager parameter to specify the Chef version, 0.9 or 11.4.\n The default value is currently 0.9. However, we expect to change the default value to 11.4 in October 2013. \n For more information, see Using AWS OpsWorks with Chef 11.

\n ", "operations": { "AssignVolume": { "name": "AssignVolume", "input": { "shape_name": "AssignVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered\n with the stack by calling RegisterVolume. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "AssociateElasticIp": { "name": "AssociateElasticIp", "input": { "shape_name": "AssociateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP address.

\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address\n must first be registered with the stack by calling RegisterElasticIp. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "AttachElasticLoadBalancer": { "name": "AttachElasticLoadBalancer", "input": { "shape_name": "AttachElasticLoadBalancerRequest", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic Load Balancing instance's name.

\n ", "required": true }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the layer that the Elastic Load Balancing instance is to be attached to.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Attaches an Elastic Load Balancing load balancer to a specified layer.

\n You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information,\n see \n Elastic Load Balancing Developer Guide.\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CloneStack": { "name": "CloneStack", "input": { "shape_name": "CloneStackRequest", "type": "structure", "members": { "SourceStackId": { "shape_name": "String", "type": "string", "documentation": "\n

The source stack ID.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The cloned stack name.

\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The cloned stack AWS region, such as \"us-east-1\". For more information about AWS regions, see\n Regions and Endpoints.

\n ", "cli_name": "stack-region" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region.\n All instances will be launched into this VPC, and you cannot change the ID later.

\n \n

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or \n the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter.\n If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified\n region and the corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n \n

For more information on how to use AWS OpsWorks with a VPC, see\n Running a Stack in a VPC. For more information on\n default VPC and EC2 Classic, see Supported Platforms.\n

\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks console,\n it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see\n Using Identifiers.

\n You must set this parameter to a valid service role ARN or the action will fail; there is no default value.\n You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.\n ", "required": true }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\n

The cloned stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n

\n " }, "HostnameTheme": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see the VpcId parameter description.\n

\n " }, "DefaultSubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in the same zone.\n For information on default values and when this parameter is required, see the VpcId parameter description.\n

\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON\n values. The string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON

\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name. This parameter must be set to \"Chef\".

\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\n

The Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.

\n " } }, "documentation": "\n

The configuration manager. When you clone a stack we recommend that you use the configuration manager to\n specify the Chef version, 0.9 or 11.4. The default value is currently 0.9.\n However, we expect to change the default value to 11.4 in September 2013.

\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to use custom cookbooks.

\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

Contains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.

\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

A default SSH key for the stack instances. You can override this value when you create or update an instance.

\n " }, "ClonePermissions": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to clone the source stack's permissions.

\n " }, "CloneAppIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of source stack app IDs to be included in the cloned stack.

\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see\n Storage for the Root Device.

\n " } }, "documentation": null }, "output": { "shape_name": "CloneStackResult", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The cloned stack ID.

\n " } }, "documentation": "

Contains the response to a CloneStack request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Creates a clone of a specified stack. For more information, see\n Clone a Stack.

\n

Required Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateApp": { "name": "CreateApp", "input": { "shape_name": "CreateAppRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\n

The app's short name.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The app name.

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the app.

\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\n

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer.\n AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.

\n ", "required": true }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

A Source object that specifies the app repository.

\n " }, "Domains": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

\n " }, "EnableSsl": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to enable SSL for the app.

\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\n

The contents of the certificate's domain.crt file.

\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\n

The private key; the contents of the certificate's domain.kex file.

\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\n

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

\n " } }, "documentation": "\n

An SslConfiguration object with the SSL configuration.

\n " }, "Attributes": { "shape_name": "AppAttributes", "type": "map", "keys": { "shape_name": "AppAttributesKeys", "type": "string", "enum": [ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " } }, "documentation": null }, "output": { "shape_name": "CreateAppResult", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID.

\n " } }, "documentation": "

Contains the response to a CreateApp request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Creates an app for a specified stack. For more information, see\n Creating Apps.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateDeployment": { "name": "CreateDeployment", "input": { "shape_name": "CreateDeploymentRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true }, "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID. This parameter is required for app deployments, but not for other deployment commands.

\n " }, "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The instance IDs for the deployment targets.

\n " }, "Command": { "shape_name": "DeploymentCommand", "type": "structure", "members": { "Name": { "shape_name": "DeploymentCommandName", "type": "string", "enum": [ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "deploy", "rollback", "start", "stop", "restart", "undeploy" ], "documentation": "\n

Specifies the deployment operation. You can specify only one command.

\n

For stacks, the available commands are:

\n \n

For apps, the available commands are:

\n \n ", "required": true }, "Args": { "shape_name": "DeploymentCommandArgs", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": null }, "documentation": "\n

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes\n command.

\n " } }, "documentation": "\n

A DeploymentCommand object that specifies the deployment command and any associated arguments.

\n ", "required": true }, "Comment": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined comment.

\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

\n " } }, "documentation": null }, "output": { "shape_name": "CreateDeploymentResult", "type": "structure", "members": { "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\n

The deployment ID, which can be used with other requests to identify the deployment.

\n " } }, "documentation": "

Contains the response to a CreateDeployment request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deploys a stack or app.

\n \n

For more information, see Deploying Apps\n and Run Stack Commands.

\n

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateInstance": { "name": "CreateInstance", "input": { "shape_name": "CreateInstanceRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array that contains the instance layer IDs.

\n ", "required": true }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\n

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

\n ", "required": true }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\n

The instance auto scaling type, which has three possible values:

\n \n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\n

The instance host name.

\n " }, "Os": { "shape_name": "String", "type": "string", "documentation": "\n

The instance operating system, which must be set to one of the following.

\n \n

The default option is Amazon Linux. If you set this parameter to Custom, you must use the\n CreateInstance action's AmiId parameter to specify\n the custom AMI that you want to use. For more information on the standard operating systems, see\n Operating SystemsFor more information\n on how to use custom AMIs with OpsWorks, see\n Using Custom AMIs.

\n " }, "AmiId": { "shape_name": "String", "type": "string", "documentation": "\n

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances

" }, "SshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

The instance SSH key name.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The instance Availability Zone. For more information, see\n Regions and Endpoints.

\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter\n to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.\n

\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\n

The instance architecture. Instance types do not necessarily support both architectures.\n For a list of the architectures that are supported by the different instance types, see\n Instance Families and Types.

\n " }, "RootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The instance root device type. For more information, see \n Storage for the Root Device.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": null }, "output": { "shape_name": "CreateInstanceResult", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " } }, "documentation": "

Contains the response to a CreateInstance request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Creates an instance in a specified stack. For more information, see\n Adding an Instance to a Layer.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateLayer": { "name": "CreateLayer", "input": { "shape_name": "CreateLayerRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer stack ID.

\n ", "required": true }, "Type": { "shape_name": "LayerType", "type": "string", "enum": [ "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ], "documentation": "\n

The layer type. A stack cannot have more than one layer of the same type. This parameter must be set to one of the following:

\n \n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The layer name, which is used by the console.

\n ", "required": true }, "Shortname": { "shape_name": "String", "type": "string", "documentation": " \n

The layer short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the\n directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric\n characters, '-', '_', and '.'.

\n ", "required": true }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "LayerAttributesKeys", "type": "string", "enum": [ "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", "HaproxyStatsPassword", "HaproxyHealthCheckUrl", "HaproxyHealthCheckMethod", "MysqlRootPassword", "MysqlRootPasswordUbiquitous", "GangliaUrl", "GangliaUser", "GangliaPassword", "MemcachedMemory", "NodejsVersion", "RubyVersion", "RubygemsVersion", "ManageBundler", "BundlerVersion", "RailsStack", "PassengerVersion", "Jvm", "JvmVersion", "JvmOptions", "JavaAppServer", "JavaAppServerVersion" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array containing the layer custom security group IDs.

\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of Package objects that describe the layer packages.

\n " }, "VolumeConfigurations": { "shape_name": "VolumeConfigurations", "type": "list", "members": { "shape_name": "VolumeConfiguration", "type": "structure", "members": { "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The volume mount point. For example \"/dev/sdh\".

\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume RAID level.

\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of disks in the volume.

\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume size.

\n ", "required": true } }, "documentation": "\n

Describes an Amazon EBS volume configuration.

\n " }, "documentation": "\n

A VolumeConfigurations object that describes the layer Amazon EBS volumes.

\n " }, "EnableAutoHealing": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to disable auto healing for the layer.

\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a setup event.

\n " }, "Configure": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a configure event.

\n " }, "Deploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a deploy event.

\n " }, "Undeploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a undeploy event.

\n " }, "Shutdown": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a shutdown event.

\n " } }, "documentation": "\n

A LayerCustomRecipes object that specifies the layer custom recipes.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": null }, "output": { "shape_name": "CreateLayerResult", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n " } }, "documentation": "

Contains the response to a CreateLayer request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Creates a layer. For more information, see\n How to Create a Layer.

\n You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type.\n A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary\n number of custom layers, so you can call CreateLayer as many times as you like for that layer type.\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateStack": { "name": "CreateStack", "input": { "shape_name": "CreateStackRequest", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The stack name.

\n ", "required": true }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS region, such as \"us-east-1\". For more information about Amazon regions, see\n Regions and Endpoints.

\n ", "required": true, "cli_name": "stack-region" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the VPC that the stack is to be launched into. It must be in the specified region.\n All instances will be launched into this VPC, and you cannot change the ID later.

\n \n

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or \n the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter.\n If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified\n region and the corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n \n

For more information on how to use AWS OpsWorks with a VPC, see\n Running a Stack in a VPC. For more information on\n default VPC and EC2 Classic, see Supported Platforms.\n

\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see\n Using Identifiers.

\n ", "required": true }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n ", "required": true }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n

\n " }, "HostnameTheme": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

\n " }, "DefaultAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see the VpcId parameter description.\n

\n " }, "DefaultSubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone.\n For information on default values and when this parameter is required, see the VpcId parameter description.\n

\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name. This parameter must be set to \"Chef\".

\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\n

The Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.

\n " } }, "documentation": "\n

The configuration manager. When you create a stack we recommend that you use the configuration manager to\n specify the Chef version, 0.9 or 11.4. The default value is currently 0.9.\n However, we expect to change the default value to 11.4 in September 2013.

\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether the stack uses custom cookbooks.

\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

Contains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.

\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

A default SSH key for the stack instances. You can override this value when you create or update an instance.

\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see \n Storage for the Root Device.

\n " } }, "documentation": null }, "output": { "shape_name": "CreateStackResult", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID, which is an opaque string that you use to identify the stack when performing actions\n such as DescribeStacks.

\n " } }, "documentation": "

Contains the response to a CreateStack request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " } ], "documentation": "\n

Creates a new stack. For more information, see\n Create a New Stack.

\n

Required Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "CreateUserProfile": { "name": "CreateUserProfile", "input": { "shape_name": "CreateUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n ", "required": true }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH user name.

\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The user's public SSH key.

\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether users can specify their own SSH public key through the My Settings page. For more information, see\n .

\n " } }, "documentation": null }, "output": { "shape_name": "CreateUserProfileResult", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n " } }, "documentation": "

Contains the response to a CreateUserProfile request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " } ], "documentation": "\n

Creates a new user profile.

\n

Required Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeleteApp": { "name": "DeleteApp", "input": { "shape_name": "DeleteAppRequest", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deletes a specified app.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeleteInstance": { "name": "DeleteInstance", "input": { "shape_name": "DeleteInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true }, "DeleteElasticIp": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to delete the instance Elastic IP address.

\n " }, "DeleteVolumes": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to delete the instance Amazon EBS volumes.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deletes a specified instance. You must stop an instance before you can delete it. For more information, see\n Deleting Instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeleteLayer": { "name": "DeleteLayer", "input": { "shape_name": "DeleteLayerRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deletes a specified layer. You must first stop and then delete all associated instances. For more information, see\n How to Delete a Layer.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeleteStack": { "name": "DeleteStack", "input": { "shape_name": "DeleteStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deletes a specified stack. You must first delete all instances, layers, and apps.\n For more information, see Shut Down a Stack.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeleteUserProfile": { "name": "DeleteUserProfile", "input": { "shape_name": "DeleteUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": " \n

Deletes a user profile.

\n

Required Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeregisterElasticIp": { "name": "DeregisterElasticIp", "input": { "shape_name": "DeregisterElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP address.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DeregisterVolume": { "name": "DeregisterVolume", "input": { "shape_name": "DeregisterVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Deregisters an Amazon EBS volume.\n The volume can then be registered by another stack. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeApps": { "name": "DescribeApps", "input": { "shape_name": "DescribeAppsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The app stack ID. If you use this parameter, DescribeApps returns a description of the\n apps in the specified stack.

\n " }, "AppIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the\n specified apps. Otherwise, it returns a description of every app.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeAppsResult", "type": "structure", "members": { "Apps": { "shape_name": "Apps", "type": "list", "members": { "shape_name": "App", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The app stack ID.

\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\n

The app's short name.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The app name.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the app.

\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\n

The app type.

\n " }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

A Source object that describes the app repository.

\n " }, "Domains": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The app vhost settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

\n " }, "EnableSsl": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to enable SSL for the app.

\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\n

The contents of the certificate's domain.crt file.

\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\n

The private key; the contents of the certificate's domain.kex file.

\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\n

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

\n " } }, "documentation": "\n

An SslConfiguration object with the SSL configuration.

\n " }, "Attributes": { "shape_name": "AppAttributes", "type": "map", "keys": { "shape_name": "AppAttributesKeys", "type": "string", "enum": [ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The contents of the stack attributes bag.

\n " }, "CreatedAt": { "shape_name": "String", "type": "string", "documentation": "\n

When the app was created.

\n " } }, "documentation": "\n

A description of the app.

\n " }, "documentation": "\n An array of App objects that describe the specified apps.\n " } }, "documentation": "

Contains the response to a DescribeApps request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Requests a description of a specified set of apps.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeCommands": { "name": "DescribeCommands", "input": { "shape_name": "DescribeCommandsRequest", "type": "structure", "members": { "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\n

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands\n associated with the specified deployment.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands\n associated with the specified instance.

\n " }, "CommandIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands.\n Otherwise, it returns a description of every command.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeCommandsResult", "type": "structure", "members": { "Commands": { "shape_name": "Commands", "type": "list", "members": { "shape_name": "Command", "type": "structure", "members": { "CommandId": { "shape_name": "String", "type": "string", "documentation": "\n

The command ID.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the instance where the command was executed.

\n " }, "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\n

The command deployment ID.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date and time when the command was run.

\n " }, "AcknowledgedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date and time when the command was acknowledged.

\n " }, "CompletedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date when the command completed.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The command status:

\n \n " }, "ExitCode": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The command exit code.

\n " }, "LogUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the command log.

\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

The command type:

\n \n " } }, "documentation": "\n

Describes a command.

\n " }, "documentation": "\n

An array of Command objects that describe each of the specified commands.

\n " } }, "documentation": "

Contains the response to a DescribeCommands request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes the results of specified commands.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeDeployments": { "name": "DescribeDeployments", "input": { "shape_name": "DescribeDeploymentsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands\n associated with the specified stack.

\n " }, "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands\n associated with the specified app.

\n " }, "DeploymentIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the\n specified deployments. Otherwise, it returns a description of every deployment.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeDeploymentsResult", "type": "structure", "members": { "Deployments": { "shape_name": "Deployments", "type": "list", "members": { "shape_name": "Deployment", "type": "structure", "members": { "DeploymentId": { "shape_name": "String", "type": "string", "documentation": "\n

The deployment ID.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date when the deployment was created.

\n " }, "CompletedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date when the deployment completed.

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The deployment duration.

\n " }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n " }, "Comment": { "shape_name": "String", "type": "string", "documentation": "\n

A user-defined comment.

\n " }, "Command": { "shape_name": "DeploymentCommand", "type": "structure", "members": { "Name": { "shape_name": "DeploymentCommandName", "type": "string", "enum": [ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "deploy", "rollback", "start", "stop", "restart", "undeploy" ], "documentation": "\n

Specifies the deployment operation. You can specify only one command.

\n

For stacks, the available commands are:

\n \n

For apps, the available commands are:

\n \n ", "required": true }, "Args": { "shape_name": "DeploymentCommandArgs", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": null }, "documentation": "\n

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes\n command.

\n " } }, "documentation": "\n

Used to specify a deployment operation.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The deployment status:

\n \n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for \n stack. The string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

\n " }, "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The IDs of the target instances.

\n " } }, "documentation": "\n

Describes a deployment of a stack or app.

\n " }, "documentation": "\n

An array of Deployment objects that describe the deployments.

\n " } }, "documentation": "

Contains the response to a DescribeDeployments request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Requests a description of a specified set of deployments.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeElasticIps": { "name": "DescribeElasticIps", "input": { "shape_name": "DescribeElasticIpsRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the\n Elastic IP addresses associated with the specified instance.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

A stack ID. If you include this parameter, DescribeElasticIps returns a description of\n the Elastic IP addresses that are registered with the specified stack.

\n " }, "Ips": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of\n the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeElasticIpsResult", "type": "structure", "members": { "ElasticIps": { "shape_name": "ElasticIps", "type": "list", "members": { "shape_name": "ElasticIp", "type": "structure", "members": { "Ip": { "shape_name": "String", "type": "string", "documentation": "\n

The IP address.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name.

\n " }, "Domain": { "shape_name": "String", "type": "string", "documentation": "\n

The domain.

\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS region. For more information, see Regions and Endpoints.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the instance that the address is attached to.

\n " } }, "documentation": "\n

Describes an Elastic IP address.

\n " }, "documentation": "\n

An ElasticIps object that describes the specified Elastic IP addresses.

\n " } }, "documentation": "

Contains the response to a DescribeElasticIps request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes Elastic IP addresses.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeElasticLoadBalancers": { "name": "DescribeElasticLoadBalancers", "input": { "shape_name": "DescribeElasticLoadBalancersRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

A stack ID. The action describes the stack's Elastic Load Balancing instances.

\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeElasticLoadBalancersResult", "type": "structure", "members": { "ElasticLoadBalancers": { "shape_name": "ElasticLoadBalancers", "type": "list", "members": { "shape_name": "ElasticLoadBalancer", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic Load Balancing instance's name.

\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The instance's AWS region.

\n " }, "DnsName": { "shape_name": "String", "type": "string", "documentation": "\n

The instance's public DNS name.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the stack that the instance is associated with.

\n " }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the layer that the instance is attached to.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC ID.

\n " }, "AvailabilityZones": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of Availability Zones.

\n " }, "SubnetIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of subnet IDs, if the stack is running in a VPC.

\n " }, "Ec2InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

\n " } }, "documentation": "\n

Describes an Elastic Load Balancing instance.

\n " }, "documentation": "\n

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

\n " } }, "documentation": "\n

Contains the response to a DescribeElasticLoadBalancers request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes a stack's Elastic Load Balancing instances.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeInstances": { "name": "DescribeInstances", "input": { "shape_name": "DescribeInstancesRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

A stack ID. If you use this parameter, DescribeInstances returns\n descriptions of the instances associated with the specified stack.

\n " }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

A layer ID. If you use this parameter, DescribeInstances returns\n descriptions of the instances associated with the specified layer.

\n " }, "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of instance IDs to be described. If you use this parameter, \n DescribeInstances returns a description of the specified instances. Otherwise, it returns\n a description of every instance.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeInstancesResult", "type": "structure", "members": { "Instances": { "shape_name": "Instances", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " }, "Ec2InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the associated Amazon EC2 instance.

\n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\n

The instance host name.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array containing the instance layer IDs.

\n " }, "SecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array containing the instance security group IDs.

\n " }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\n

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that specify the various types are in the API Name column of the Available Instance Types table.

\n " }, "InstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of the instance's IAM profile. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The instance status:

\n \n " }, "Os": { "shape_name": "String", "type": "string", "documentation": "\n

The instance operating system.

\n " }, "AmiId": { "shape_name": "String", "type": "string", "documentation": "\n

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The instance Availability Zone. For more information, see\n Regions and Endpoints.

\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance's subnet ID, if the stack is running in a VPC.

\n " }, "PublicDns": { "shape_name": "String", "type": "string", "documentation": "\n

The instance public DNS name.

\n " }, "PrivateDns": { "shape_name": "String", "type": "string", "documentation": "\n

The instance private DNS name.

\n " }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n

The instance public IP address.

\n " }, "PrivateIp": { "shape_name": "String", "type": "string", "documentation": "\n

The instance private IP address.

\n " }, "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The instance Elastic IP address .

\n " }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\n

The instance's auto scaling type, which has three possible values:

\n " }, "SshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

The instance SSH key name.

\n " }, "SshHostRsaKeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\n

The SSH key's RSA fingerprint.

\n " }, "SshHostDsaKeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\n

The SSH key's DSA fingerprint.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

The time that the instance was created.

\n " }, "LastServiceErrorId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the last service error. For more information, call DescribeServiceErrors.

\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\n

The instance architecture, \"i386\" or \"x86_64\".

\n " }, "RootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The instance root device type. For more information, see\n Storage for the Root Device.

\n " }, "RootDeviceVolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The root device volume ID.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n If this value is set to false, you must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": "\n

Describes an instance.

\n " }, "documentation": "\n

An array of Instance objects that describe the instances.

\n " } }, "documentation": "

Contains the response to a DescribeInstances request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Requests a description of a set of instances.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeLayers": { "name": "DescribeLayers", "input": { "shape_name": "DescribeLayersRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of layer IDs that specify the layers to be described. If you omit this parameter,\n DescribeLayers returns a description of every layer in the specified stack.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeLayersResult", "type": "structure", "members": { "Layers": { "shape_name": "Layers", "type": "list", "members": { "shape_name": "Layer", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer stack ID.

\n " }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n " }, "Type": { "shape_name": "LayerType", "type": "string", "enum": [ "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ], "documentation": "\n

The layer type, which must be one of the following:

\n \n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The layer name.

\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\n

The layer short name.

\n " }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "LayerAttributesKeys", "type": "string", "enum": [ "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", "HaproxyStatsPassword", "HaproxyHealthCheckUrl", "HaproxyHealthCheckMethod", "MysqlRootPassword", "MysqlRootPasswordUbiquitous", "GangliaUrl", "GangliaUser", "GangliaPassword", "MemcachedMemory", "NodejsVersion", "RubyVersion", "RubygemsVersion", "ManageBundler", "BundlerVersion", "RailsStack", "PassengerVersion", "Jvm", "JvmVersion", "JvmOptions", "JavaAppServer", "JavaAppServerVersion" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The layer attributes.

\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": " \n

An array containing the layer's custom security group IDs.

\n " }, "DefaultSecurityGroupNames": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array containing the layer's security group names.

\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of Package objects that describe the layer's packages.

\n " }, "VolumeConfigurations": { "shape_name": "VolumeConfigurations", "type": "list", "members": { "shape_name": "VolumeConfiguration", "type": "structure", "members": { "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The volume mount point. For example \"/dev/sdh\".

\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume RAID level.

\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of disks in the volume.

\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume size.

\n ", "required": true } }, "documentation": "\n

Describes an Amazon EBS volume configuration.

\n " }, "documentation": "\n

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

\n " }, "EnableAutoHealing": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether auto healing is disabled for the layer.

\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "DefaultRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a setup event.

\n " }, "Configure": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a configure event.

\n " }, "Deploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a deploy event.

\n " }, "Undeploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a undeploy event.

\n " }, "Shutdown": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a shutdown event.

\n " } }, "documentation": "\n

AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown.\n For each layer, AWS OpsWorks runs a set of standard recipes for each event.\n In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes.\n LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.\n

\n \n

To specify a recipe, use the cookbook's directory name in the repository\n followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup\n specifies the dbsetup.rb recipe in the repository's phpapp2 folder.\n

\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a setup event.

\n " }, "Configure": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a configure event.

\n " }, "Deploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a deploy event.

\n " }, "Undeploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a undeploy event.

\n " }, "Shutdown": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a shutdown event.

\n " } }, "documentation": "\n

A LayerCustomRecipes object that specifies the layer's custom recipes.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date when the layer was created.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n If this value is set to false, you must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": "\n

Describes a layer.

\n " }, "documentation": "\n

An array of Layer objects that describe the layers.

\n " } }, "documentation": "

Contains the response to a DescribeLayers request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Requests a description of one or more layers in a specified stack.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeLoadBasedAutoScaling": { "name": "DescribeLoadBasedAutoScaling", "input": { "shape_name": "DescribeLoadBasedAutoScalingRequest", "type": "structure", "members": { "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of layer IDs.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeLoadBasedAutoScalingResult", "type": "structure", "members": { "LoadBasedAutoScalingConfigurations": { "shape_name": "LoadBasedAutoScalingConfigurations", "type": "list", "members": { "shape_name": "LoadBasedAutoScalingConfiguration", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n " }, "Enable": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether load-based auto scaling is enabled for the layer.

\n " }, "UpScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances to add or remove when the load exceeds a threshold.

\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.

\n " }, "CpuThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The CPU utilization threshold, as a percent of the available CPU.

\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The memory utilization threshold, as a percent of the available memory.

\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The load threshold. For more information about how load is computed, see\n Load (computing).

\n " } }, "documentation": "\n

A LoadBasedAutoscalingInstruction object that describes the upscaling configuration, which \n defines how and when AWS OpsWorks increases the number of instances.

\n " }, "DownScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances to add or remove when the load exceeds a threshold.

\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.

\n " }, "CpuThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The CPU utilization threshold, as a percent of the available CPU.

\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The memory utilization threshold, as a percent of the available memory.

\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The load threshold. For more information about how load is computed, see\n Load (computing).

\n " } }, "documentation": "\n

A LoadBasedAutoscalingInstruction object that describes the downscaling configuration, which \n defines how and when AWS OpsWorks reduces the number of instances.

\n " } }, "documentation": "\n

Describes a layer's load-based auto scaling configuration.

\n " }, "documentation": "\n

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

\n " } }, "documentation": "

Contains the response to a DescribeLoadBasedAutoScaling request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes load-based auto scaling configurations for specified layers.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeMyUserProfile": { "name": "DescribeMyUserProfile", "input": null, "output": { "shape_name": "DescribeMyUserProfileResult", "type": "structure", "members": { "UserProfile": { "shape_name": "SelfUserProfile", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The user's name.

\n " }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH user name.

\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH public key.

\n " } }, "documentation": "\n

A UserProfile object that describes the user's SSH information.

\n " } }, "documentation": "\n

Contains the response to a DescribeMyUserProfile request.

\n " }, "errors": [], "documentation": "\n

Describes a user's SSH information.

\n

Required Permissions: To use this action, an IAM user must have self-management enabled\n or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribePermissions": { "name": "DescribePermissions", "input": { "shape_name": "DescribePermissionsRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribePermissionsResult", "type": "structure", "members": { "Permissions": { "shape_name": "Permissions", "type": "list", "members": { "shape_name": "Permission", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

A stack ID.

\n " }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "AllowSsh": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether the user can use SSH.

\n " }, "AllowSudo": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether the user can use sudo.

\n " }, "Level": { "shape_name": "String", "type": "string", "documentation": "\n

The user's permission level, which must be the following:

\n \n

For more information on the permissions associated with these levels, see\n Managing User Permissions

\n " } }, "documentation": "\n

Describes stack or user permissions.

\n " }, "documentation": "\n

An array of Permission objects that describe the stack permissions.

\n \n " } }, "documentation": "

Contains the response to a DescribePermissions request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes the permissions for a specified stack.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeRaidArrays": { "name": "DescribeRaidArrays", "input": { "shape_name": "DescribeRaidArraysRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID. If you use this parameter, DescribeRaidArrays returns\n descriptions of the RAID arrays associated with the specified instance.

\n " }, "RaidArrayIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns\n descriptions of the specified arrays. Otherwise, it returns a description of every array.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeRaidArraysResult", "type": "structure", "members": { "RaidArrays": { "shape_name": "RaidArrays", "type": "list", "members": { "shape_name": "RaidArray", "type": "structure", "members": { "RaidArrayId": { "shape_name": "String", "type": "string", "documentation": "\n

The array ID.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The array name.

\n " }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The RAID level.

\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of disks in the array.

\n " }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The array's size.

\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

The array's Linux device. For example /dev/mdadm0.

\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The array's mount point.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The array's Availability Zone. For more information, see\n Regions and Endpoints.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

When the RAID array was created.

\n " } }, "documentation": "\n

Describes an instance's RAID array.

\n " }, "documentation": "\n

A RaidArrays object that describes the specified RAID arrays.

\n " } }, "documentation": "\n

Contains the response to a DescribeRaidArrays request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describe an instance's RAID arrays.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions.\n For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeServiceErrors": { "name": "DescribeServiceErrors", "input": { "shape_name": "DescribeServiceErrorsRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified stack.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.

\n " }, "ServiceErrorIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns\n descriptions of the specified errors. Otherwise, it returns a description of every error.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeServiceErrorsResult", "type": "structure", "members": { "ServiceErrors": { "shape_name": "ServiceErrors", "type": "list", "members": { "shape_name": "ServiceError", "type": "structure", "members": { "ServiceErrorId": { "shape_name": "String", "type": "string", "documentation": "\n

The error ID.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n

The error type.

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

A message that describes the error.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

When the error occurred.

\n " } }, "documentation": "\n

Describes an AWS OpsWorks service error.

\n " }, "documentation": "\n

An array of ServiceError objects that describe the specified service errors.

\n " } }, "documentation": "\n

Contains the response to a DescribeServiceErrors request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes AWS OpsWorks service errors.

\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeStackSummary": { "name": "DescribeStackSummary", "input": { "shape_name": "DescribeStackSummaryRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeStackSummaryResult", "type": "structure", "members": { "StackSummary": { "shape_name": "StackSummary", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The stack name.

\n " }, "LayersCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of layers.

\n " }, "AppsCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of apps.

\n " }, "InstancesCount": { "shape_name": "InstancesCount", "type": "structure", "members": { "Booting": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with booting status.

\n " }, "ConnectionLost": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with connection_lost status.

\n " }, "Pending": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with pending status.

\n " }, "Rebooting": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with rebooting status.

\n " }, "Requested": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with requested status.

\n " }, "RunningSetup": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with running_setup status.

\n " }, "SetupFailed": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with setup_failed status.

\n " }, "ShuttingDown": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with shutting_down status.

\n " }, "StartFailed": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with start_failed status.

\n " }, "Stopped": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with stopped status.

\n " }, "Terminated": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with terminated status.

\n " }, "Terminating": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances with terminating status.

\n " } }, "documentation": "\n

An InstancesCount object with the number of instances in each status.

\n " } }, "documentation": "\n

A StackSummary object that contains the results.

\n " } }, "documentation": "

Contains the response to a DescribeStackSummary request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes the number of layers and apps in a specified stack, and the number of instances in\n each state, such as running_setup or online.

\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

" }, "DescribeStacks": { "name": "DescribeStacks", "input": { "shape_name": "DescribeStacksRequest", "type": "structure", "members": { "StackIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of stack IDs that specify the stacks to be described. If you omit this parameter,\n DescribeStacks returns a description of every stack.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeStacksResult", "type": "structure", "members": { "Stacks": { "shape_name": "Stacks", "type": "list", "members": { "shape_name": "Stack", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The stack name.

\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS region, such as \"us-east-1\". For more information about AWS regions, see\n Regions and Endpoints.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC ID, if the stack is running in a VPC.

\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The contents of the stack's attributes bag.

\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS Identity and Access Management (IAM) role.

\n " }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n

\n " }, "HostnameTheme": { "shape_name": "String", "type": "string", "documentation": "\n

The stack host name theme, with spaces replaced by underscores.

\n " }, "DefaultAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default Availability Zone. For more information, see\n Regions and Endpoints.

\n " }, "DefaultSubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The default subnet ID, if the stack is running in a VPC.

\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values.\nThe string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name. This parameter must be set to \"Chef\".

\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\n

The Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.

\n " } }, "documentation": "\n

The configuration manager.

\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether the stack uses custom cookbooks.

\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

Contains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.

\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

A default SSH key for the stack's instances. You can override this value when you create or update an instance.

\n " }, "CreatedAt": { "shape_name": "DateTime", "type": "string", "documentation": "\n

Date when the stack was created.

\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance. For more information, see\n Storage for the Root Device.

\n " } }, "documentation": "\n

Describes a stack.

\n " }, "documentation": "\n

An array of Stack objects that describe the stacks.

\n " } }, "documentation": "

Contains the response to a DescribeStacks request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Requests a description of one or more stacks.

\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeTimeBasedAutoScaling": { "name": "DescribeTimeBasedAutoScaling", "input": { "shape_name": "DescribeTimeBasedAutoScalingRequest", "type": "structure", "members": { "InstanceIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of instance IDs.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeTimeBasedAutoScalingResult", "type": "structure", "members": { "TimeBasedAutoScalingConfigurations": { "shape_name": "TimeBasedAutoScalingConfigurations", "type": "list", "members": { "shape_name": "TimeBasedAutoScalingConfiguration", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " }, "AutoScalingSchedule": { "shape_name": "WeeklyAutoScalingSchedule", "type": "structure", "members": { "Monday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Monday.

\n " }, "Tuesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Tuesday.

\n " }, "Wednesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Wednesday.

\n " }, "Thursday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Thursday.

\n " }, "Friday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Friday.

\n " }, "Saturday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Saturday.

\n " }, "Sunday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Sunday.

\n " } }, "documentation": "\n

A WeeklyAutoScalingSchedule object with the instance schedule.

\n " } }, "documentation": "\n

Describes an instance's time-based auto scaling configuration.

\n " }, "documentation": "\n

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

\n " } }, "documentation": "\n

Contains the response to a DescribeTimeBasedAutoScaling request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes time-based auto scaling configurations for specified instances.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeUserProfiles": { "name": "DescribeUserProfiles", "input": { "shape_name": "DescribeUserProfilesRequest", "type": "structure", "members": { "IamUserArns": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of IAM user ARNs that identify the users to be described.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeUserProfilesResult", "type": "structure", "members": { "UserProfiles": { "shape_name": "UserProfiles", "type": "list", "members": { "shape_name": "UserProfile", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The user's name.

\n " }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH user name.

\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH public key.

\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether users can specify their own SSH public key through the My Settings page. For more information, see\n Managing User Permissions.

\n " } }, "documentation": "\n

Describes a user's SSH information.

\n " }, "documentation": "\n

A Users object that describes the specified users.

\n " } }, "documentation": "\n

Contains the response to a DescribeUserProfiles request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": " \n

Describe specified users.

\n

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions.\n For more information on user permissions, see\n Managing User Permissions.

\n " }, "DescribeVolumes": { "name": "DescribeVolumes", "input": { "shape_name": "DescribeVolumesRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified instance.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

A stack ID. The action describes the stack's registered Amazon EBS volumes.

\n " }, "RaidArrayId": { "shape_name": "String", "type": "string", "documentation": "\n

The RAID array ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified RAID array.

\n " }, "VolumeIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Am array of volume IDs. If you use this parameter, DescribeVolumes returns\n descriptions of the specified volumes. Otherwise, it returns a description of every volume.

\n " } }, "documentation": null }, "output": { "shape_name": "DescribeVolumesResult", "type": "structure", "members": { "Volumes": { "shape_name": "Volumes", "type": "list", "members": { "shape_name": "Volume", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n " }, "Ec2VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon EC2 volume ID.

\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The volume name.

\n " }, "RaidArrayId": { "shape_name": "String", "type": "string", "documentation": "\n

The RAID array ID.

\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The value returned by\n DescribeVolumes.

\n " }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume size.

\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\n

The device name.

\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The volume mount point. For example \"/dev/sdh\".

\n " }, "Region": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS region. For more information about AWS regions, see\n Regions and Endpoints.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": " \n

The volume Availability Zone. For more information, see\n Regions and Endpoints.

\n " } }, "documentation": "\n

Describes an instance's Amazon EBS volume.

\n " }, "documentation": "\n

An array of volume IDs.

\n " } }, "documentation": "

Contains the response to a DescribeVolumes request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Describes an instance's Amazon EBS volumes.

\n You must specify at least one of the parameters.\n

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DetachElasticLoadBalancer": { "name": "DetachElasticLoadBalancer", "input": { "shape_name": "DetachElasticLoadBalancerRequest", "type": "structure", "members": { "ElasticLoadBalancerName": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic Load Balancing instance's name.

\n ", "required": true }, "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The ID of the layer that the Elastic Load Balancing instance is attached to.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Detaches a specified Elastic Load Balancing instance from its layer.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "DisassociateElasticIp": { "name": "DisassociateElasticIp", "input": { "shape_name": "DisassociateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP address.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "GetHostnameSuggestion": { "name": "GetHostnameSuggestion", "input": { "shape_name": "GetHostnameSuggestionRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "GetHostnameSuggestionResult", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\n

The generated host name.

\n " } }, "documentation": "

Contains the response to a GetHostnameSuggestion request.

" }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Gets a generated host name for the specified layer, based on the current host name theme.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "RebootInstance": { "name": "RebootInstance", "input": { "shape_name": "RebootInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Reboots a specified instance. For more information, see\n Starting, Stopping, and Rebooting Instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "RegisterElasticIp": { "name": "RegisterElasticIp", "input": { "shape_name": "RegisterElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP address.

\n ", "required": true }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RegisterElasticIpResult", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP address.

\n " } }, "documentation": "\n

Contains the response to a RegisterElasticIp request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Registers an Elastic IP address with a specified stack. An address can be\n registered with only one stack at a time. If the address is already registered, you must first deregister it\n by calling DeregisterElasticIp. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

" }, "RegisterVolume": { "name": "RegisterVolume", "input": { "shape_name": "RegisterVolumeRequest", "type": "structure", "members": { "Ec2VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon EBS volume ID.

\n " }, "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RegisterVolumeResult", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n " } }, "documentation": "\n

Contains the response to a RegisterVolume request.

\n " }, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Registers an Amazon EBS volume with a specified stack. A volume can be\n registered with only one stack at a time. If the volume is already registered, you must first deregister it\n by calling DeregisterVolume. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "SetLoadBasedAutoScaling": { "name": "SetLoadBasedAutoScaling", "input": { "shape_name": "SetLoadBasedAutoScalingRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n ", "required": true }, "Enable": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Enables load-based auto scaling for the layer.

\n " }, "UpScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances to add or remove when the load exceeds a threshold.

\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.

\n " }, "CpuThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The CPU utilization threshold, as a percent of the available CPU.

\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The memory utilization threshold, as a percent of the available memory.

\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The load threshold. For more information about how load is computed, see\n Load (computing).

\n " } }, "documentation": "\n

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds\n these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.

\n " }, "DownScaling": { "shape_name": "AutoScalingThresholds", "type": "structure", "members": { "InstanceCount": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of instances to add or remove when the load exceeds a threshold.

\n " }, "ThresholdsWaitTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

\n " }, "IgnoreMetricsTime": { "shape_name": "Minute", "type": "integer", "min_length": 1, "max_length": 100, "documentation": "\n

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics\n and not raise any additional scaling events.\n For example, AWS OpsWorks adds new instances following an upscaling event but the instances\n won't start reducing the load until they have been booted and configured.\n There is no point in raising additional scaling events during that operation, which typically takes several minutes.\n IgnoreMetricsTime allows you to direct AWS OpsWorks to not raise any scaling events long enough\n to get the new instances online.

\n " }, "CpuThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The CPU utilization threshold, as a percent of the available CPU.

\n " }, "MemoryThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The memory utilization threshold, as a percent of the available memory.

\n " }, "LoadThreshold": { "shape_name": "Double", "type": "double", "box": true, "documentation": "\n

The load threshold. For more information about how load is computed, see\n Load (computing).

\n " } }, "documentation": "\n

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls\n below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Specify the load-based auto scaling configuration for a specified layer. For more information, see\n Managing Load\n with Time-based and Load-based Instances.

\n To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only \n on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "SetPermission": { "name": "SetPermission", "input": { "shape_name": "SetPermissionRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true }, "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user's IAM ARN.

\n ", "required": true }, "AllowSsh": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

The user is allowed to use SSH to communicate with the instance.

\n " }, "AllowSudo": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

The user is allowed to use sudo to elevate privileges.

\n " }, "Level": { "shape_name": "String", "type": "string", "documentation": "\n

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

\n \n

For more information on the permissions associated with these levels, see\n Managing User Permissions

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Specifies a stack's permissions. For more information, see\n Security and Permissions.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "SetTimeBasedAutoScaling": { "name": "SetTimeBasedAutoScaling", "input": { "shape_name": "SetTimeBasedAutoScalingRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true }, "AutoScalingSchedule": { "shape_name": "WeeklyAutoScalingSchedule", "type": "structure", "members": { "Monday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Monday.

\n " }, "Tuesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Tuesday.

\n " }, "Wednesday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Wednesday.

\n " }, "Thursday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Thursday.

\n " }, "Friday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Friday.

\n " }, "Saturday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Saturday.

\n " }, "Sunday": { "shape_name": "DailyAutoScalingSchedule", "type": "map", "keys": { "shape_name": "Hour", "type": "string", "documentation": null }, "members": { "shape_name": "Switch", "type": "string", "documentation": null }, "documentation": "\n

The schedule for Sunday.

\n " } }, "documentation": "\n

An AutoScalingSchedule with the instance schedule.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Specify the time-based auto scaling configuration for a specified instance. For more information,\n see Managing Load\n with Time-based and Load-based Instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "StartInstance": { "name": "StartInstance", "input": { "shape_name": "StartInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Starts a specified instance. For more information, see\n Starting, Stopping,\n and Rebooting Instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "StartStack": { "name": "StartStack", "input": { "shape_name": "StartStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Starts stack's instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "StopInstance": { "name": "StopInstance", "input": { "shape_name": "StopInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Stops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data.\n For more information, see\n Starting, Stopping,\n and Rebooting Instances.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "StopStack": { "name": "StopStack", "input": { "shape_name": "StopStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Stops a specified stack.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UnassignVolume": { "name": "UnassignVolume", "input": { "shape_name": "UnassignVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateApp": { "name": "UpdateApp", "input": { "shape_name": "UpdateAppRequest", "type": "structure", "members": { "AppId": { "shape_name": "String", "type": "string", "documentation": "\n

The app ID.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The app name.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description of the app.

\n " }, "Type": { "shape_name": "AppType", "type": "string", "enum": [ "rails", "php", "nodejs", "static", "other" ], "documentation": "\n

The app type.

\n " }, "AppSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

A Source object that specifies the app repository.

\n " }, "Domains": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

\n " }, "EnableSsl": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether SSL is enabled for the app.

\n " }, "SslConfiguration": { "shape_name": "SslConfiguration", "type": "structure", "members": { "Certificate": { "shape_name": "String", "type": "string", "documentation": "\n

The contents of the certificate's domain.crt file.

\n ", "required": true }, "PrivateKey": { "shape_name": "String", "type": "string", "documentation": "\n

The private key; the contents of the certificate's domain.kex file.

\n ", "required": true }, "Chain": { "shape_name": "String", "type": "string", "documentation": "\n

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

\n " } }, "documentation": "\n

An SslConfiguration object with the SSL configuration.

\n " }, "Attributes": { "shape_name": "AppAttributes", "type": "map", "keys": { "shape_name": "AppAttributesKeys", "type": "string", "enum": [ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a specified app.

\n

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack,\n or an attached policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateElasticIp": { "name": "UpdateElasticIp", "input": { "shape_name": "UpdateElasticIpRequest", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The address.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The new name.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a registered Elastic IP address's name. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateInstance": { "name": "UpdateInstance", "input": { "shape_name": "UpdateInstanceRequest", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

The instance ID.

\n ", "required": true }, "LayerIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The instance's layer IDs.

\n " }, "InstanceType": { "shape_name": "String", "type": "string", "documentation": "\n

The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster.\n For more information, see Instance Families and Types.\n The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

\n " }, "AutoScalingType": { "shape_name": "AutoScalingType", "type": "string", "enum": [ "load", "timer" ], "documentation": "\n

The instance's auto scaling type, which has three possible values:

\n \n " }, "Hostname": { "shape_name": "String", "type": "string", "documentation": "\n

The instance host name.

\n " }, "Os": { "shape_name": "String", "type": "string", "documentation": "\n

The instance operating system, which must be set to one of the following.

\n \n

The default option is Amazon Linux. If you set this parameter to Custom, you must use the\n CreateInstance action's AmiId parameter to specify\n the custom AMI that you want to use. For more information on the standard operating systems, see\n Operating SystemsFor more information\n on how to use custom AMIs with OpsWorks, see\n Using Custom AMIs.

\n " }, "AmiId": { "shape_name": "String", "type": "string", "documentation": "\n

A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs:\n Amazon Linux or Ubuntu 12.04 LTS. For more information, see\n Instances

\n " }, "SshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

The instance SSH key name.

\n " }, "Architecture": { "shape_name": "Architecture", "type": "string", "enum": [ "x86_64", "i386" ], "documentation": "\n

The instance architecture. Instance types do not necessarily support both architectures.\n For a list of the architectures that are supported by the different instance types, see\n Instance Families and Types.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a specified instance.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateLayer": { "name": "UpdateLayer", "input": { "shape_name": "UpdateLayerRequest", "type": "structure", "members": { "LayerId": { "shape_name": "String", "type": "string", "documentation": "\n

The layer ID.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The layer name, which is used by the console.

\n " }, "Shortname": { "shape_name": "String", "type": "string", "documentation": "\n

The layer short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the\n directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format:\n /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n " }, "Attributes": { "shape_name": "LayerAttributes", "type": "map", "keys": { "shape_name": "LayerAttributesKeys", "type": "string", "enum": [ "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", "HaproxyStatsPassword", "HaproxyHealthCheckUrl", "HaproxyHealthCheckMethod", "MysqlRootPassword", "MysqlRootPasswordUbiquitous", "GangliaUrl", "GangliaUser", "GangliaPassword", "MemcachedMemory", "NodejsVersion", "RubyVersion", "RubygemsVersion", "ManageBundler", "BundlerVersion", "RailsStack", "PassengerVersion", "Jvm", "JvmVersion", "JvmOptions", "JavaAppServer", "JavaAppServerVersion" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " }, "CustomInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "CustomSecurityGroupIds": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array containing the layer's custom security group IDs.

\n " }, "Packages": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of Package objects that describe the layer's packages.

\n " }, "VolumeConfigurations": { "shape_name": "VolumeConfigurations", "type": "list", "members": { "shape_name": "VolumeConfiguration", "type": "structure", "members": { "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The volume mount point. For example \"/dev/sdh\".

\n ", "required": true }, "RaidLevel": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume RAID level.

\n " }, "NumberOfDisks": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The number of disks in the volume.

\n ", "required": true }, "Size": { "shape_name": "Integer", "type": "integer", "box": true, "documentation": "\n

The volume size.

\n ", "required": true } }, "documentation": "\n

Describes an Amazon EBS volume configuration.

\n " }, "documentation": "\n

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

\n " }, "EnableAutoHealing": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to disable auto healing for the layer.

\n " }, "AutoAssignElasticIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to automatically assign an Elastic\n IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "AutoAssignPublicIps": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances.\n For more information, see How to Edit a Layer.

\n " }, "CustomRecipes": { "shape_name": "Recipes", "type": "structure", "members": { "Setup": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a setup event.

\n " }, "Configure": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a configure event.

\n " }, "Deploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a deploy event.

\n " }, "Undeploy": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a undeploy event.

\n " }, "Shutdown": { "shape_name": "Strings", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

An array of custom recipe names to be run following a shutdown event.

\n " } }, "documentation": "\n

A LayerCustomRecipes object that specifies the layer's custom recipes.

\n " }, "InstallUpdatesOnBoot": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether to install operating system and package updates when the instance boots. The default value is true.\n To control when updates are installed, set this value to false. You must then update your instances manually by\n using CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.\n

\n We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a specified layer.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateMyUserProfile": { "name": "UpdateMyUserProfile", "input": { "shape_name": "UpdateMyUserProfileRequest", "type": "structure", "members": { "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The user's SSH public key.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " } ], "documentation": "\n

Updates a user's SSH public key.

\n

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateStack": { "name": "UpdateStack", "input": { "shape_name": "UpdateStackRequest", "type": "structure", "members": { "StackId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack ID.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's new name.

\n " }, "Attributes": { "shape_name": "StackAttributes", "type": "map", "keys": { "shape_name": "StackAttributesKeys", "type": "string", "enum": [ "Color" ], "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": " \n

One or more user-defined key/value pairs to be added to the stack attributes bag.

\n " }, "ServiceRoleArn": { "shape_name": "String", "type": "string", "documentation": "\n

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf.\n You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see\n Using Identifiers.

\n You must set this parameter to a valid service role ARN or the action will fail; there is no default value.\n You can specify the stack's current service role ARN, if you prefer, but you must do so explicitly.\n " }, "DefaultInstanceProfileArn": { "shape_name": "String", "type": "string", "documentation": "\n

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see\n Using Identifiers.

\n " }, "DefaultOs": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default operating system, which must be set to Amazon Linux or Ubuntu 12.04 LTS.\n The default option is Amazon Linux.\n

\n " }, "HostnameTheme": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's new host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

\n " }, "DefaultAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default Availability Zone, which must be in the specified region. For more information, see\n Regions and Endpoints.\n If you also specify a value for DefaultSubnetId, the subnet must be in the same zone.\n For more information, see CreateStack.\n

\n " }, "DefaultSubnetId": { "shape_name": "String", "type": "string", "documentation": "\n

The stack's default subnet ID.\n All instances will be launched into this subnet unless you specify otherwise when you create the instance.\n If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone.\n For more information, see CreateStack.\n

\n " }, "CustomJson": { "shape_name": "String", "type": "string", "documentation": "\n

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. \nThe string should be in the following format and must escape characters such as '\"'.:

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.

\n " }, "ConfigurationManager": { "shape_name": "StackConfigurationManager", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The name. This parameter must be set to \"Chef\".

\n " }, "Version": { "shape_name": "String", "type": "string", "documentation": "\n

The Chef version. This parameter must be set to \"0.9\" or \"11.4\". The default value is \"0.9\".\n However, we expect to change the default value to \"11.4\" in September 2013.

\n " } }, "documentation": "\n

The configuration manager. When you update a stack you can optionally use the configuration manager to\n specify the Chef version, 0.9 or 11.4. If you omit this parameter, AWS OpsWorks does not change\n the Chef version.\n

\n " }, "UseCustomCookbooks": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": " \n

Whether the stack uses custom cookbooks.

\n " }, "CustomCookbooksSource": { "shape_name": "Source", "type": "structure", "members": { "Type": { "shape_name": "SourceType", "type": "string", "enum": [ "git", "svn", "archive", "s3" ], "documentation": "\n

The repository type.

\n " }, "Url": { "shape_name": "String", "type": "string", "documentation": "\n

The source URL.

" }, "Username": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "Password": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter depends on the repository type.

\n \n " }, "SshKey": { "shape_name": "String", "type": "string", "documentation": "\n

The repository's SSH key.

\n " }, "Revision": { "shape_name": "String", "type": "string", "documentation": "\n

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application.\n One of the simplest approaches is to have branches or revisions in your repository that represent different\n versions that can potentially be deployed.

\n " } }, "documentation": "\n

Contains the information required to retrieve an app or cookbook from a repository. For more information, see\n Creating Apps or\n Custom Recipes and Cookbooks.

\n " }, "DefaultSshKeyName": { "shape_name": "String", "type": "string", "documentation": "\n

A default SSH key for the stack instances. You can override this value when you create or update an instance.

\n " }, "DefaultRootDeviceType": { "shape_name": "RootDeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\n

The default root device type. This value is used by default for all instances in the cloned stack,\n but you can override it when you create an instance.\n For more information, see Storage for the Root Device.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a specified stack.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateUserProfile": { "name": "UpdateUserProfile", "input": { "shape_name": "UpdateUserProfileRequest", "type": "structure", "members": { "IamUserArn": { "shape_name": "String", "type": "string", "documentation": "\n

The user IAM ARN.

\n ", "required": true }, "SshUsername": { "shape_name": "String", "type": "string", "documentation": "\n

The user's new SSH user name.

\n " }, "SshPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The user's new SSH public key.

\n " }, "AllowSelfManagement": { "shape_name": "Boolean", "type": "boolean", "box": true, "documentation": "\n

Whether users can specify their own SSH public key through the My Settings page. For more information, see\n Managing User Permissions.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates a specified user profile.

\n

Required Permissions: To use this action, an IAM user must have an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " }, "UpdateVolume": { "name": "UpdateVolume", "input": { "shape_name": "UpdateVolumeRequest", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\n

The volume ID.

\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\n

The new name.

\n " }, "MountPoint": { "shape_name": "String", "type": "string", "documentation": "\n

The new mount point.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "ValidationException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a request was invalid.

\n " }, { "shape_name": "ResourceNotFoundException", "type": "structure", "members": { "message": { "shape_name": "String", "type": "string", "documentation": "\n

The exception message.

\n " } }, "documentation": "\n

Indicates that a resource was not found.

\n " } ], "documentation": "\n

Updates an Amazon EBS volume's name or mount point. For more information, see\n Resource Management.

\n

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached\n policy that explicitly grants permissions. For more information on user permissions, see\n Managing User Permissions.

\n " } }, "metadata": { "regions": { "us-east-1": null }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/rds.json0000644000175000017500000341354512254746566017752 0ustar takakitakaki{ "api_version": "2013-09-09", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Relational Database Service", "service_abbreviation": "Amazon RDS", "endpoint_prefix": "rds", "xmlnamespace": "http://rds.amazonaws.com/doc/2013-09-09/", "documentation": "\n Amazon Relational Database Service \n

\n Amazon Relational Database Service (Amazon RDS) is a web service\n that makes it easier to set up, operate, and scale a relational\n database in the cloud. It provides cost-efficient, resizable\n capacity for an industry-standard relational database and manages\n common database administration tasks, freeing up developers to focus\n on what makes their applications and businesses unique. \n

\n

\n Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle \n database server. This means the code, applications, and tools you\n already use today with your existing MySQL or Oracle databases work with Amazon\n RDS without modification. Amazon RDS automatically backs up your database\n and maintains the database software that powers your DB instance. Amazon\n RDS is flexible: you can scale your database instance's compute resources\n and storage capacity to meet your application's demand. As with all\n Amazon Web Services, there are no up-front investments, and you pay\n only for the resources you use. \n

\n

\n This is an interface reference for Amazon RDS. It contains documentation for a\n programming or command line interface you can use to manage Amazon RDS. Note\n that Amazon RDS is asynchronous, which means that some interfaces may require\n techniques such as polling or callback functions to determine when a command has\n been applied. In this reference, the parameter descriptions indicate whether a\n command is applied immediately, on the next instance reboot, or during the\n maintenance window. For a summary of the Amazon RDS interfaces, go to \n Available RDS Interfaces.\n

\n ", "operations": { "AddSourceIdentifierToSubscription": { "name": "AddSourceIdentifierToSubscription", "input": { "shape_name": "AddSourceIdentifierToSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the RDS event notification subscription you want to add a source identifier to.

\n ", "required": true }, "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the event source to be added. An identifier must begin with a letter and must contain only \n ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.\n

\n \n

Constraints:

\n \n ", "required": true } }, "documentation": " \n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n " } } }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The subscription name does not exist.

\n " }, { "shape_name": "SourceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested source could not be found.

\n " } ], "documentation": "\n

Adds a source identifier to an existing RDS event notification subscription.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=AddSourceIdentifierToSubscription\n ?SubscriptionName=EventSubscription01\n &SourceIdentifier=dbinstance01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T011410Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n\n \n \n true\n 012345678901\n db-instance\n modifying\n \n dbinstance01\n \n 2013-01-28 00:29:23.736\n \n creation\n deletion\n \n EventSubscription01\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n 05d0fd8a-68e8-11e2-8e4d-31f087d822e1\n \n\n \n \n \n " }, "AddTagsToResource": { "name": "AddTagsToResource", "input": { "shape_name": "AddTagsToResourceMessage", "type": "structure", "members": { "ResourceName": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

The tags to be assigned to the Amazon RDS resource.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " } ], "documentation": "\n

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with \n Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.

\n

For an overview on tagging Amazon RDS resources, \n see Tagging Amazon RDS Resources.

\n " }, "AuthorizeDBSecurityGroupIngress": { "name": "AuthorizeDBSecurityGroupIngress", "input": { "shape_name": "AuthorizeDBSecurityGroupIngressMessage", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group to add authorization to.\n

\n ", "required": true }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range to authorize.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Id of the EC2 security group to authorize.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n AWS Account Number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS Access Key ID is not an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSecurityGroupWrapper", "type": "structure", "members": { "DBSecurityGroup": { "shape_name": "DBSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the AWS ID of the owner of a specific DB security group.\n

\n " }, "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB security group.\n

\n " }, "DBSecurityGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB security group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the EC2 security group.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the id of the EC2 security group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n Contains a list of EC2SecurityGroup elements.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP range.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n Contains a list of IPRange elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSecurityGroups action.

\n \n " } } }, "errors": [ { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " }, { "shape_name": "InvalidDBSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB security group does not allow deletion.\n

\n " }, { "shape_name": "AuthorizationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.\n

\n " }, { "shape_name": "AuthorizationQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n DB security group authorization quota has been reached.\n

\n " } ], "documentation": "\n

\n Enables ingress to a DBSecurityGroup using one of two forms of authorization. First,\n EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database\n is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your\n database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or\n (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).\n

\n \n You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB instance in another.\n You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.\n \n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

\n \n https://rds.amazonaws.com/\n ?CIDRIP=192.168.1.1%2F24\n &DBSecurityGroupName=mydbsecuritygroup\n &Version=2013-05-15\n &Action=AuthorizeDBSecurityGroupIngress\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A10%3A50.274Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n My new DBSecurityGroup\n \n \n 192.168.1.1/24\n authorizing\n \n \n 621567473609\n mydbsecuritygroup\n vpc-1ab2c3d4\n \n \n \n d9799197-bf2d-11de-b88d-993294bf1c81\n \n\n \n " }, "CopyDBSnapshot": { "name": "CopyDBSnapshot", "input": { "shape_name": "CopyDBSnapshotMessage", "type": "structure", "members": { "SourceDBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the source DB snapshot.\n

\n

Constraints:

\n \n

Example: rds:mydb-2012-04-02-00-01

\n

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

\n ", "required": true }, "TargetDBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the copied snapshot.\n

\n

Constraints:

\n \n

Example: my-db-snapshot

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSnapshotWrapper", "type": "structure", "members": { "DBSnapshot": { "shape_name": "DBSnapshot", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier for the DB snapshot.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DB instance identifier of the DB instance\n this DB snapshot was created from.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the time (UTC) when the snapshot was taken.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the database engine.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size in gigabytes (GB).\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of this DB snapshot.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB\n instance was located in at the time of the DB snapshot.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the Vpc Id associated with the DB snapshot.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the time (UTC) when the snapshot was taken.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the master username for the DB snapshot.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the version of the database engine.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the type of the DB snapshot.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the option group name for the DB snapshot.\n

\n " }, "PercentProgress": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The percentage of the estimated data that has been transferred.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The region that the DB snapshot was created in or copied from.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSnapshots action.

\n " } } }, "errors": [ { "shape_name": "DBSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " }, { "shape_name": "InvalidDBSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB snapshot does not allow deletion.\n

\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB snapshots.\n

\n " } ], "documentation": "\n

\n Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.\n

\n \n https://rds.amazonaws.com/\n ?Action=CopyDBSnapshot\n &SourceDBSnapshotIdentifier=rds:simcoprod01-2012-04-02-00-01\n &TargetDBSnapshotIdentifier=mydbsnapshot\n &Version=2013-05-15\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-12-12T06%3A27%3A42.551Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 3306\n mysql\n available\n us-east-1a\n general-public-license\n 2011-05-23T06:06:43.110Z\n 10\n simcoprod01\n 5.1.50\n mydbsnapshot\n manual\n master\n \n \n \n c4181d1d-8505-11e0-90aa-eb648410240d\n \n\n \n " }, "CreateDBInstance": { "name": "CreateDBInstance", "input": { "shape_name": "CreateDBInstanceMessage", "type": "structure", "members": { "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter\n differs according to the database\n engine you use.

\n

MySQL

\n

The name of the database to create when the DB instance\n is created. If this parameter is not specified,\n no database is created in the DB instance.\n

\n

Constraints:

\n \n

Type: String

\n \n

Oracle

\n

\n The Oracle System ID (SID) of the created DB instance. \n

\n \n

Default: ORCL

\n \n

Constraints:

\n \n\n

SQL Server

\n

Not applicable. Must be null.

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier.\n This parameter is stored as a lowercase string.\n

\n

Constraints:

\n \n

Example: mydbinstance

\n ", "required": true }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The amount of storage (in gigabytes) to be initially allocated for the\n database instance. \n

\n

MySQL

\n

Constraints: Must be an integer from 5 to 1024.

\n

Type: Integer

\n

Oracle

\n

Constraints: Must be an integer from 10 to 1024.

\n

SQL Server

\n

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or \n from 30 to 1024 (Express Edition and Web Edition)

\n ", "required": true }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The compute and memory capacity of the DB instance.\n

\n

\n Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge\n

\n \n ", "required": true }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the database engine to be used for this instance.\n

\n

\n Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | \n sqlserver-se | sqlserver-ex | sqlserver-web\n

\n ", "required": true }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of master user for the client DB instance.\n

\n

MySQL

\n

Constraints:

\n \n

Type: String

\n

Oracle

\n

Constraints:

\n \n

SQL Server

\n

Constraints:

\n \n\n \n ", "required": true }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".\n

\n

Type: String

\n

MySQL

\n

\n Constraints: Must contain from 8 to 41 characters. \n

\n \n

Oracle

\n

\n Constraints: Must contain from 8 to 30 characters. \n

\n

SQL Server

\n

\n Constraints: Must contain from 8 to 128 characters.\n

\n \n ", "required": true }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "DBSecurityGroupName" }, "documentation": "\n

\n A list of DB security groups to associate\n with this DB instance.\n

\n

\n Default: The default DB security group for the database engine.\n

\n " }, "VpcSecurityGroupIds": { "shape_name": "VpcSecurityGroupIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcSecurityGroupId" }, "documentation": "\n

\n A list of EC2 VPC security groups to associate\n with this DB instance.\n

\n

\n Default: The default EC2 VPC security group for the DB subnet group's\n VPC.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The EC2 Availability Zone that the database instance will be created in.\n

\n

\n Default: A random, system-chosen Availability Zone in the endpoint's region.\n

\n

\n Example: us-east-1d\n

\n

\n Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. \n The specified Availability Zone must be in the same region as the current endpoint.\n

\n " }, "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n A DB subnet group to associate with this DB instance.\n

\n

\n If there is no DB subnet group, then it is a non-VPC DB instance.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which system maintenance can occur.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region, occurring on a random day of the\n week. To see the time blocks available, see \n \n Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.\n

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

\n " }, "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group to associate\n with this DB instance. If this argument is omitted, the default\n DBParameterGroup for the specified engine will be used.\n

\n

\n Constraints:\n

\n \n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days for which automated backups are retained.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n

\n

\n Default: 1\n

\n

Constraints:

\n \n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region. See the Amazon RDS User Guide for \n the time blocks for each region from which the default \n backup windows are assigned.\n

\n\n

\n Constraints: Must be in the format hh24:mi-hh24:mi. \n Times should be Universal Time Coordinated (UTC). \n Must not conflict with the preferred maintenance window. Must be at least 30 minutes.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number on which the database accepts connections.\n

\n

MySQL

\n

\n Default: 3306\n

\n

\n Valid Values: 1150-65535\n

\n

Type: Integer

\n \n

Oracle

\n

\n Default: 1521\n

\n

\n Valid Values: 1150-65535\n

\n

SQL Server

\n

\n Default: 1433\n

\n

\n Valid Values: 1150-65535 except for 1434 and 3389.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment. \n You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. \n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version number of the database engine to use.\n

\n

MySQL

\n

Example: 5.1.42

\n

Type: String

\n \n

Oracle

\n

Example: 11.2.0.2.v2

\n

Type: String

\n \n

SQL Server

\n

Example: 10.50.2789.0.v1

\n \n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that minor engine upgrades will be applied\n automatically to the DB instance during the maintenance window.\n

\n

Default: true

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the\n DB instance. \n

\n

Constraints: Must be an integer greater than 1000.

\n \n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates that the DB instance should be associated with the specified option group.\n

\n

\n \n Permanent options, such as the TDE option for Oracle Advanced Security TDE, \n cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance\n

\n \n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.\n

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "DBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a DB instance with the given identifier.\n

\n " }, { "shape_name": "InsufficientDBInstanceCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified DB instance class is not available in the specified Availability Zone.\n

\n " }, { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " }, { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " }, { "shape_name": "InstanceQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB instances.\n

\n " }, { "shape_name": "StorageQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the\n allowed amount of storage available across all DB instances.\n

\n " }, { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n DB subnet group does not cover all Availability Zones after it is created because users' change.\n

\n " }, { "shape_name": "ProvisionedIopsNotAvailableInAZFault", "type": "structure", "members": {}, "documentation": "\n

\n Provisioned IOPS not available in the specified Availability Zone.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " } ], "documentation": "\n

\n Creates a new DB instance.\n

\n \n https://rds.amazonaws.com/\n ?Action=CreateDBInstance\n &DBInstanceIdentifier=SimCoProd01\n &Engine=mysql\n &MasterUserPassword=Password01\n &AllocatedStorage=10\n &MasterUsername=master\n &Version=2013-05-15\n &DBInstanceClass=db.m1.large\n &DBSubnetGroupName=dbSubnetgroup01\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T05%3A54%3A53.578Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql\n \n ****\n \n 1\n false\n general-public-license\n \n 990524496922\n Complete\n description\n subnet_grp1\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n creating\n 5.1.50\n simcoprod01\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n 10\n db.m1.large\n master\n \n \n \n 2e5d4270-8501-11e0-bd9b-a7b1ece36d51\n \n\n \n " }, "CreateDBInstanceReadReplica": { "name": "CreateDBInstanceReadReplica", "input": { "shape_name": "CreateDBInstanceReadReplicaMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier of the read replica.\n This is the unique key that identifies a DB instance.\n This parameter is stored as a lowercase string.\n

\n ", "required": true }, "SourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.\n

\n

Constraints:

\n \n ", "required": true }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The compute and memory capacity of the read replica.\n

\n

\n Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge\n

\n

Default: Inherits from the source DB instance.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon EC2 Availability Zone that the read replica will be created in.\n

\n

\n Default: A random, system-chosen Availability Zone in the endpoint's region.\n

\n

\n Example: us-east-1d\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number that the DB instance uses for connections.\n

\n

Default: Inherits from the source DB instance

\n

Valid Values: 1150-65535

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that minor engine upgrades will be applied automatically\n to the read replica during the maintenance window.\n

\n

Default: Inherits from the source DB instance

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The amount of Provisioned IOPS (input/output operations per second) to be initially \n allocated for the DB instance. \n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The option group the DB instance will be associated with. If omitted, the default option group\n for the engine specified will be used.\n

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " }, "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

A DB Subnet Group to associate with this DB Instance in case of a cross region read replica.

\n

If there is no DB Subnet Group, then it is a non-VPC DB instance.

\n

\n \tConstraints: All the cross region read replicas that share the source instance \n \tshould lie within the same VPC. \n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "DBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a DB instance with the given identifier.\n

\n " }, { "shape_name": "InsufficientDBInstanceCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified DB instance class is not available in the specified Availability Zone.\n

\n " }, { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " }, { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " }, { "shape_name": "InstanceQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB instances.\n

\n " }, { "shape_name": "StorageQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the\n allowed amount of storage available across all DB instances.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n DB subnet group does not cover all Availability Zones after it is created because users' change.\n

\n " }, { "shape_name": "ProvisionedIopsNotAvailableInAZFault", "type": "structure", "members": {}, "documentation": "\n

\n Provisioned IOPS not available in the specified Availability Zone.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " }, { "shape_name": "DBSubnetGroupNotAllowedFault", "type": "structure", "members": {}, "documentation": "\n

\n\t\tIndicates that the DBSubnetGroup should not be specified while creating read replicas\n\t\tthat lie in the same region as the source instance.\n

\n " }, { "shape_name": "InvalidDBSubnetGroupFault", "type": "structure", "members": {}, "documentation": "\n

\n\t\tIndicates the DBSubnetGroup does not belong to the same VPC \n\t\tas that of an existing cross region read replica of the same source instance.\n

\n " } ], "documentation": "\n

\n Creates a DB instance that acts as a read replica of a source DB instance.\n

\n

\n All read replica DB instances are created as Single-AZ deployments with backups disabled.\n All other DB instance attributes (including DB security groups and DB parameter groups)\n are inherited from the source DB instance, except as specified below.\n

\n \n

\n The source DB instance must have backup retention enabled.\n

\n \n \n https://rds.amazonaws.com/\n ?Action=CreateDBInstanceReadReplica\n &DBInstanceIdentifier=myreadreplica\n &SourceDBInstanceIdentifier=mydbinstance\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-15T23%3A35%3A07.325Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql\n \n 0\n false\n general-public-license\n creating\n 5.1.50\n myreadreplica\n \n \n in-sync\n default.mysql5.1\n \n \n mydbinstance\n \n \n active\n default\n \n \n 23:00-01:00\n true\n sun:05:00-sun:09:00\n 10\n db.m1.small\n master\n \n \n \n 3e24c5cd-c6e2-11df-8463-4f0c49644cb7\n \n\n \n " }, "CreateDBParameterGroup": { "name": "CreateDBParameterGroup", "input": { "shape_name": "CreateDBParameterGroupMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n

\n Constraints:\n

\n \n This value is stored as a lower-case string.\n ", "required": true }, "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB parameter group family name. A DB parameter group can be \n associated with one and only one DB parameter group family, and \n can be applied only to a DB instance running a database engine and engine version \n compatible with that DB parameter group family.\n

\n\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the DB parameter group.\n

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBParameterGroupWrapper", "type": "structure", "members": { "DBParameterGroup": { "shape_name": "DBParameterGroup", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the DB parameter group.\n

\n " }, "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the DB parameter group family that\n this DB parameter group is compatible with.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the customer-specified description for this DB parameter group.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the CreateDBParameterGroup action.\n

\n

\n This data type is used as a request parameter in the DeleteDBParameterGroup action,\n and as a response element in the DescribeDBParameterGroups action.\n

\n " } } }, "errors": [ { "shape_name": "DBParameterGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed\n number of DB parameter groups.\n

\n " }, { "shape_name": "DBParameterGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n A DB parameter group with the same name exists.\n

\n " } ], "documentation": "\n

\n Creates a new DB parameter group.\n

\n

\n A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n Instance for the new DB parameter group and associated settings to take effect. \n

\n \n https://rds.amazonaws.com/\n ?Action=CreateDBParameterGroup\n &DBParameterGroupName=mydbparametergroup3\n &DBParameterGroupFamily=MySQL5.1\n &Version=2013-05-15\n &Description=My%20new%20DBParameterGroup\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T18%3A09%3A29.793Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n mysql5.1\n My new DBParameterGroup\n mydbparametergroup3\n \n \n \n 0b447b66-bf36-11de-a88b-7b5b3d23b3a7\n \n\n \n " }, "CreateDBSecurityGroup": { "name": "CreateDBSecurityGroup", "input": { "shape_name": "CreateDBSecurityGroupMessage", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the DB security group.\n This value is stored as a lowercase string.\n

\n

Constraints:

\n \n

Example: mysecuritygroup

\n ", "required": true }, "DBSecurityGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the DB security group.\n

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSecurityGroupWrapper", "type": "structure", "members": { "DBSecurityGroup": { "shape_name": "DBSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the AWS ID of the owner of a specific DB security group.\n

\n " }, "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB security group.\n

\n " }, "DBSecurityGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB security group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the EC2 security group.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the id of the EC2 security group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n Contains a list of EC2SecurityGroup elements.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP range.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n Contains a list of IPRange elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSecurityGroups action.

\n \n " } } }, "errors": [ { "shape_name": "DBSecurityGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n A DB security group with the name specified in\n DBSecurityGroupName already exists.\n

\n " }, { "shape_name": "DBSecurityGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB security groups.\n

\n " }, { "shape_name": "DBSecurityGroupNotSupportedFault", "type": "structure", "members": {}, "documentation": "\n

\n A DB security group is not allowed for this action.\n

\n " } ], "documentation": "\n

\n Creates a new DB security group. DB security groups control access to a DB instance.\n

\n \n https://rds.amazonaws.com/\n ?Action=CreateDBSecurityGroup\n &DBSecurityGroupName=mydbsecuritygroup\n &DBSecurityGroupDescription=My%20new%20DBSecurityGroup\n &EC2VpcId=vpc-1a2b3c4d\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n My new DBSecurityGroup\n \n 565419523791\n mydbsecuritygroup\n vpc-1a2b3c4d\n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n\n \n " }, "CreateDBSnapshot": { "name": "CreateDBSnapshot", "input": { "shape_name": "CreateDBSnapshotMessage", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the DB snapshot.\n

\n

Constraints:

\n \n

Example: my-snapshot-id

\n ", "required": true }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier. This is the unique key\n that identifies a DB instance. This parameter isn't case sensitive.\n

\n

Constraints:

\n \n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSnapshotWrapper", "type": "structure", "members": { "DBSnapshot": { "shape_name": "DBSnapshot", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier for the DB snapshot.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DB instance identifier of the DB instance\n this DB snapshot was created from.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the time (UTC) when the snapshot was taken.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the database engine.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size in gigabytes (GB).\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of this DB snapshot.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB\n instance was located in at the time of the DB snapshot.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the Vpc Id associated with the DB snapshot.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the time (UTC) when the snapshot was taken.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the master username for the DB snapshot.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the version of the database engine.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the type of the DB snapshot.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the option group name for the DB snapshot.\n

\n " }, "PercentProgress": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The percentage of the estimated data that has been transferred.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The region that the DB snapshot was created in or copied from.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSnapshots action.

\n " } } }, "errors": [ { "shape_name": "DBSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB snapshots.\n

\n " } ], "documentation": "\n

\n Creates a DBSnapshot. The source DBInstance must be in \"available\" state.\n

\n \n https://rds.amazonaws.com/\n ?Action=CreateDBSnapshot\n &DBInstanceIdentifier=simcoprod01\n &DBSnapshotIdentifier=mydbsnapshot\n &Version=2013-05-15\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 3306\n mysql\n creating\n us-east-1a\n general-public-license\n 2011-05-23T06:06:43.110Z\n 10\n simcoprod01\n 5.1.50\n mydbsnapshot\n manual\n master\n \n \n \n c4181d1d-8505-11e0-90aa-eb648410240d\n \n\n \n " }, "CreateDBSubnetGroup": { "name": "CreateDBSubnetGroup", "input": { "shape_name": "CreateDBSubnetGroupMessage", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the DB subnet group.\n This value is stored as a lowercase string.\n

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

\n \n

Example: mySubnetgroup

\n ", "required": true }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the DB subnet group.\n

\n ", "required": true }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

\n The EC2 Subnet IDs for the DB subnet group.\n

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSubnetGroupWrapper", "type": "structure", "members": { "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSubnetGroups action.

\n " } } }, "errors": [ { "shape_name": "DBSubnetGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName is already used by an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB subnet groups.\n

\n " }, { "shape_name": "DBSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of subnets in a DB subnet groups.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " } ], "documentation": "\n

\n Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.\n

\n \n https://rds.amazonaws.com/\n ?Action=CreateDBSubnetGroup\n &DBSubnetGroupName=mydbsubnetgroup\n &DBSubnetGroupDescription=My%20new%20DBSubnetGroup\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 990524496922\n Complete\n My new DBSubnetGroup\n mydbsubnetgroup\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n \n " }, "CreateEventSubscription": { "name": "CreateEventSubscription", "input": { "shape_name": "CreateEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": " \n

The name of the subscription.

\n

Constraints: The name must be less than 255 characters.

\n ", "required": true }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create \n a topic and subscribe to it.\n

\n ", "required": true }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, \n you would set this parameter to db-instance. if this value is not specified, all events are returned.\n

\n

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

\n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType \n in the Events topic in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.\n

\n " }, "SourceIds": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

\n The list of identifiers of the event sources for which events will be returned. If not specified,\n then all sources are included in the response. An identifier must begin with a letter and must contain only \n ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.\n

\n

Constraints:

\n \n " }, "Enabled": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.\n

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": " \n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n " } } }, "errors": [ { "shape_name": "EventSubscriptionQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

You have reached the maximum number of event subscriptions.

\n " }, { "shape_name": "SubscriptionAlreadyExistFault", "type": "structure", "members": {}, "documentation": "\n

The supplied subscription name already exists.

\n " }, { "shape_name": "SNSInvalidTopicFault", "type": "structure", "members": {}, "documentation": "\n

SNS has responded that there is a problem with the SND topic specified.

\n " }, { "shape_name": "SNSNoAuthorizationFault", "type": "structure", "members": {}, "documentation": "\n

You do not have permission to publish to the SNS topic ARN.

\n " }, { "shape_name": "SNSTopicArnNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The SNS topic ARN does not exist.

\n " }, { "shape_name": "SubscriptionCategoryNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The supplied category does not exist.

\n " }, { "shape_name": "SourceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested source could not be found.

\n " } ], "documentation": "\n

Creates an RDS event notification subscription. This action requires a topic ARN \n (Amazon Resource Name) created by either \n the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in \n Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

\n

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS \n sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) \n for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and \n EventCategories = Availability, Backup.

\n

If you specify both the SourceType and SourceIds, such as \n SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance \n events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, \n you will receive notice of the events for that source type for all your RDS sources. If you \n do not specify either the SourceType nor the SourceIdentifier, you will be notified of events \n generated from all RDS sources belonging to your customer account.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=CreateEventSubscription\n &SubscriptionName=EventSubscription02\n &Enabled=true\n &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A012345678901%3AEventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T002941Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n true\n 012345678901\n creating\n Mon Jan 28 00:29:42 UTC 2013\n EventSubscription02\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n cf3407aa-68e1-11e2-bd13-a92da73b3119\n \n\n \n \n https://rds.us-east-1.amazonaws.com/\n ?Action=CreateEventSubscription\n &SubscriptionName=EventSubscription03\n &SourceType=db-instance\n &EventCategories.member.1=creation\n &EventCategories.member.2=deletion\n &SourceIds.member.1=dbinstance01\n &SourceIds.member.2=dbinstance02\n &Enabled=true\n &SnsTopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A012345678901%3AEventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T014117Z\n &AWSAccessKeyId=\n &Signature=\n \n \n\n \n \n true\n 012345678901\n db-instance\n creating\n \n dbinstance01\n dbinstance02\n \n Mon Jan 28 01:41:19 UTC 2013\n \n creation\n deletion\n \n EventSubscription03\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n d064b48c-68eb-11e2-ab10-11125abcb784\n \n\n\n \n \n \n " }, "CreateOptionGroup": { "name": "CreateOptionGroup", "input": { "shape_name": "CreateOptionGroupMessage", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the option group to be created.\n

\n

\n Constraints:\n

\n \n

Example: myoptiongroup

\n \n ", "required": true }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the engine that this option group should be associated with.\n

\n ", "required": true }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the major version of the engine that this option group should be associated with.\n

\n ", "required": true }, "OptionGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option group.\n

\n ", "required": true }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "OptionGroupWrapper", "type": "structure", "members": { "OptionGroup": { "shape_name": "OptionGroup", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the option group.\n

\n " }, "OptionGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the option group.\n

\n " }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Engine name that this option group can be applied to.\n

\n " }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the major engine version associated with this option group.\n

\n " }, "Options": { "shape_name": "OptionsList", "type": "list", "members": { "shape_name": "Option", "type": "structure", "members": { "OptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option.\n

\n " }, "OptionDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option.\n

\n " }, "Persistent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicate if this option is persistent.\n

\n " }, "Permanent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicate if this option is permanent.

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n If required, the port configured for this option to use.\n

\n " }, "OptionSettings": { "shape_name": "OptionSettingConfigurationList", "type": "list", "members": { "shape_name": "OptionSetting", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option that has settings that you can set.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current value of the option setting.\n

\n " }, "DefaultValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The default value of the option setting.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option setting.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB engine specific parameter type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the option setting.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allowed values of the option setting.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A Boolean value that, when true, indicates the option setting can be modified from the default.\n

\n " }, "IsCollection": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the option setting is part of a collection.\n

\n " } }, "documentation": "\n

\n Option settings are the actual settings being applied or configured \n for that option. It is used when you modify an option group or describe \n option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting \n called SQLNET.ENCRYPTION_SERVER that can have several different values.\n

\n ", "xmlname": "OptionSetting" }, "documentation": "\n

\n The option settings for this option. \n

\n " }, "DBSecurityGroupMemberships": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n If the option requires access to a port, then this DB security group allows access to the port. \n

\n " }, "VpcSecurityGroupMemberships": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n If the option requires access to a port, then this VPC security group allows access to the port.\n

\n " } }, "documentation": "\n

\n Option details.\n

\n", "xmlname": "Option" }, "documentation": "\n

\n Indicates what options are available in the option group.\n

\n " }, "AllowsVpcAndNonVpcInstanceMemberships": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

\n " } }, "wrapper": true, "documentation": "\n

\n

\n " } } }, "errors": [ { "shape_name": "OptionGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": " \n

\n The option group you are trying to create already exists.\n

\n " }, { "shape_name": "OptionGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": " \n

\n The quota of 20 option groups was exceeded for this AWS account.\n

\n " } ], "documentation": "\n

\n Creates a new option group. You can create up to 20 option groups.\n

\n \n https://rds.amazonaws.com/\n ?Action=CreateOptionGroup\n &OptionGroupName=myoptiongroup\n &EngineName=oracle-se1\n &MajorEngineVersion=11.2\n &OptionGroupDescription=Test option group\n \n \n \n 11.2\n myoptiongroup\n oracle-se1\n Test option group\n \n \n \n \n b2416a8a-84c9-11e1-a264-0b23c28bc344\n \n \n \n " }, "DeleteDBInstance": { "name": "DeleteDBInstance", "input": { "shape_name": "DeleteDBInstanceMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier for the DB instance to be deleted.\n This parameter isn't case sensitive.\n

\n

Constraints:

\n \n ", "required": true }, "SkipFinalSnapshot": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Determines whether a final DB snapshot is created before the DB instance is deleted. \n If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot \n is created before the DB instance is deleted.\n

\n

Specify true when deleting a read replica.

\n The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.\n

Default: false

\n " }, "FinalDBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot\n is set to false.\n

\n \n Specifying this parameter and also setting \n the SkipFinalShapshot parameter to true results in an error.\n \n

Constraints:

\n \n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "DBSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "SnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB snapshots.\n

\n " } ], "documentation": "\n

\n The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response\n from the web service indicates the request was received correctly. \n When you delete a DB instance, all automated backups for that instance are deleted \n and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.\n

\n

\n If a final DB snapshot is requested\n the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance\n is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.\n

\n \n https://rds.amazonaws.com/\n ?Action=DeleteDBInstance\n &DBInstanceIdentifier=myrestoreddbinstance\n &SkipFinalSnapshot=true\n &Version=2013-05-15\n &Timestamp=2011-05-23T07%3A19%3A35.947Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 2011-05-23T07:15:00Z\n mysql\n \n 1\n false\n general-public-license\n deleting\n 5.1.50\n \n 3306\n
myrestoreddbinstance.cu7u2t4uz396.us-east.rds.amazonaws.com
\n \n myrestoreddbinstance\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n us-east-1d\n 2011-05-23T06:52:48.255Z\n 10\n db.m1.large\n master\n \n \n \n 03ea4ae8-850d-11e0-90aa-eb648410240d\n \n\n \n " }, "DeleteDBParameterGroup": { "name": "DeleteDBParameterGroup", "input": { "shape_name": "DeleteDBParameterGroupMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n

Constraints:

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidDBParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB parameter group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " } ], "documentation": "\n

\n Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with\n any RDS instances to be deleted.\n

\n \n The specified DB parameter group cannot be associated with any DB instances.\n \n \n https://rds.amazonaws.com/\n ?Action=DeleteDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Version=2013-05-15\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T18%3A47%3A08.851Z\n &AWSAccessKeyId=\n &Signature=\n \n \n 4dc38be9-bf3b-11de-a88b-7b5b3d23b3a7\n \n\n \n " }, "DeleteDBSecurityGroup": { "name": "DeleteDBSecurityGroup", "input": { "shape_name": "DeleteDBSecurityGroupMessage", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group to delete.\n

\n You cannot delete the default DB security group.\n

\n Constraints:\n

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidDBSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB security group does not allow deletion.\n

\n " }, { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " } ], "documentation": "\n

\n Deletes a DB security group. \n

\n The specified DB security group must not be associated with any DB instances.\n \n https://rds.amazonaws.com/\n ?Action=DeleteDBSecurityGroup\n &DBSecurityGroupName=mysecuritygroup\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A48%3A21.746Z\n &AWSAccessKeyId=\n &Signature=\n \n \n 5d013245-4172-11df-8520-e7e1e602a915\n \n\n \n " }, "DeleteDBSnapshot": { "name": "DeleteDBSnapshot", "input": { "shape_name": "DeleteDBSnapshotMessage", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DBSnapshot identifier.\n

\n

Constraints: Must be the name of an existing DB snapshot in the available state.

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSnapshotWrapper", "type": "structure", "members": { "DBSnapshot": { "shape_name": "DBSnapshot", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier for the DB snapshot.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DB instance identifier of the DB instance\n this DB snapshot was created from.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the time (UTC) when the snapshot was taken.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the database engine.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size in gigabytes (GB).\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of this DB snapshot.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB\n instance was located in at the time of the DB snapshot.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the Vpc Id associated with the DB snapshot.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the time (UTC) when the snapshot was taken.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the master username for the DB snapshot.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the version of the database engine.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the type of the DB snapshot.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the option group name for the DB snapshot.\n

\n " }, "PercentProgress": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The percentage of the estimated data that has been transferred.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The region that the DB snapshot was created in or copied from.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSnapshots action.

\n " } } }, "errors": [ { "shape_name": "InvalidDBSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB snapshot does not allow deletion.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " } ], "documentation": "\n

\n Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.\n

\n The DBSnapshot must be in the available state to be\n deleted.\n \n https://rds.amazon.com/\n &DBSnapshotIdentifier=mydbsnapshot\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 3306\n 2011-03-11T07:20:24.082Z\n mysql\n deleted\n us-east-1d\n general-public-license\n 2010-07-16T00:06:59.107Z\n 60\n simcoprod01\n 5.1.47\n mysnapshot2\n manual\n master\n \n \n \n 627a43a1-8507-11e0-bd9b-a7b1ece36d51\n \n\n \n " }, "DeleteDBSubnetGroup": { "name": "DeleteDBSubnetGroup", "input": { "shape_name": "DeleteDBSubnetGroupMessage", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the database subnet group to delete.\n

\n You cannot delete the default subnet group.\n

\n Constraints:\n

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidDBSubnetGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB subnet group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "InvalidDBSubnetStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB subnet is not in the available state.\n

\n " }, { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " } ], "documentation": "\n

\n Deletes a DB subnet group. \n

\n The specified database subnet group must not be associated with any DB instances.\n \n https://rds.amazonaws.com/\n ?Action=DeleteDBSubnetGroup\n &DBSubnetGroupName=mysubnetgroup\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A48%3A21.746Z\n &AWSAccessKeyId=\n &Signature=\n \n \n 5d013245-4172-11df-8520-e7e1e602a915\n \n \n \n " }, "DeleteEventSubscription": { "name": "DeleteEventSubscription", "input": { "shape_name": "DeleteEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the RDS event notification subscription you want to delete.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n " } } }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The subscription name does not exist.

\n " }, { "shape_name": "InvalidEventSubscriptionStateFault", "type": "structure", "members": {}, "documentation": "\n

This error can occur if someone else is modifying a subscription. You should retry the action.

\n " } ], "documentation": "\n

Deletes an RDS event notification subscription.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=DeleteEventSubscription\n &SubscriptionName=EventSubscription01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T012739Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n\n \n \n true\n 012345678901\n db-instance\n deleting\n 2013-01-28 00:29:23.736\n \n creation\n deletion\n \n EventSubscription01\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n e7cf30ac-68e9-11e2-bd13-a92da73b3119\n \n\n\n \n \n " }, "DeleteOptionGroup": { "name": "DeleteOptionGroup", "input": { "shape_name": "DeleteOptionGroupMessage", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group to be deleted.\n

\n You cannot delete default option groups.\n ", "required": true } }, "documentation": "\n

\n

\n " }, "output": null, "errors": [ { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " }, { "shape_name": "InvalidOptionGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The option group is not in the available state.\n

\n " } ], "documentation": "\n

\n Deletes an existing option group.\n

\n \n https://rds.amazonaws.com/\n ?Action=DeleteOptionGroup\n &OptionGroupName=myoptiongroup\n \n \n \n " }, "DescribeDBEngineVersions": { "name": "DescribeDBEngineVersions", "input": { "shape_name": "DescribeDBEngineVersionsMessage", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database engine to return.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database engine version to return.\n

\n

Example: 5.1.49

\n " }, "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a specific DB parameter group family to return details for.\n

\n

Constraints:

\n \n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DefaultOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that only the default version of the specified engine\n or engine and major version combination is returned.\n

\n " }, "ListSupportedCharacterSets": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n If this parameter is specified, and if the requested engine supports the \n CharacterSetName parameter for CreateDBInstance, the response includes a\n list of supported character sets for each engine version.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "DBEngineVersionMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DBEngineVersions": { "shape_name": "DBEngineVersionList", "type": "list", "members": { "shape_name": "DBEngineVersion", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the database engine.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version number of the database engine.\n

\n " }, "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group family for the database engine.\n

\n " }, "DBEngineDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the database engine.\n

\n " }, "DBEngineVersionDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the database engine version.\n

\n " }, "DefaultCharacterSet": { "shape_name": "CharacterSet", "type": "structure", "members": { "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the character set.\n

\n " }, "CharacterSetDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the character set.\n

\n " } }, "documentation": "\n

\n The default character set for new instances of this engine version,\n if the CharacterSetName parameter of the CreateDBInstance API\n is not specified.\n

\n " }, "SupportedCharacterSets": { "shape_name": "SupportedCharacterSetsList", "type": "list", "members": { "shape_name": "CharacterSet", "type": "structure", "members": { "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the character set.\n

\n " }, "CharacterSetDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the character set.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the action DescribeDBEngineVersions. \n

\n ", "xmlname": "CharacterSet" }, "documentation": "\n

\n A list of the character sets supported by this engine for the\n CharacterSetName parameter of the CreateDBInstance API. \n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the action DescribeDBEngineVersions.\n

\n ", "xmlname": "DBEngineVersion" }, "documentation": "\n

\n A list of DBEngineVersion elements.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBEngineVersions action.\n

\n " }, "errors": [], "documentation": "\n

\n Returns a list of the available DB engines.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeDBEngineVersions\n &MaxRecords=100\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T07%3A34%3A17.435Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql5.1\n mysql\n 5.1.42\n \n \n mysql5.1\n mysql\n Use instead of mysql5.1\n 5.1.45\n yaSSL Security Fixes\n \n \n mysql5.1\n mysql\n Use instead of mysql5.1\n 5.1.47\n MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8\n \n \n mysql5.1\n mysql\n Use instead of mysql5.1\n 5.1.48\n MySQL 5.1.47.R1 with InnoDB Plugin 1.0.8\n \n \n mysql5.1\n mysql\n Use instead of mysql5.1\n 5.1.49\n MySQL 5.1.49-R1 with innodb plugin\n \n \n mysql5.1\n mysql\n Use instead of mysql5.1\n 5.1.50\n MySQL 5.1.50-R3\n \n \n mysql5.5\n mysql\n Use instead of mysql5.1\n 5.5.7\n MySQL 5.5.7.R1\n \n \n oracle-ee-11.2\n oracle-ee\n Oracle Database Server EE\n 11.2.0.2\n Oracle EE release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-ee-11.2\n oracle-ee\n Oracle Database Server EE\n 11.2.0.2.v2\n First Oracle Enterprise Edition One - DB Engine Version 11.2.0.2.v2\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-ee-11.2\n oracle-ee\n Oracle Database Server EE\n 11.2.0.2.v3\n Oracle EE release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se-11.2\n oracle-se\n Oracle Database Server SE\n 11.2.0.2\n Oracle SE release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se-11.2\n oracle-se\n Oracle Database Server SE\n 11.2.0.2.v2\n Oracle SE release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se-11.2\n oracle-se\n Oracle Database Server SE\n 11.2.0.2.v3\n Oracle SE release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se1-11.2\n oracle-se1\n Oracle Database Server SE1\n 11.2.0.2\n Oracle SE1 release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se1-11.2\n oracle-se1\n Oracle Database Server SE1\n 11.2.0.2.v2\n Oracle SE1 release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n oracle-se1-11.2\n oracle-se1\n Oracle Database Server SE1\n 11.2.0.2.v3\n Oracle SE1 release\n \n AL32UTF8\n Unicode 5.0 UTF-8 Universal character set\n \n \n \n \n \n 1162dc55-850f-11e0-90aa-eb648410240d\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBEngineVersions", "py_input_token": "marker" } }, "DescribeDBInstances": { "name": "DescribeDBInstances", "input": { "shape_name": "DescribeDBInstancesMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The user-supplied instance identifier.\n If this parameter is specified, information from only the\n specific DB instance is returned.\n This parameter isn't case sensitive.\n

\n

Constraints:

\n \n \n \n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeDBInstances request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

\n " }, "DBInstances": { "shape_name": "DBInstanceList", "type": "list", "members": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n ", "xmlname": "DBInstance" }, "documentation": "\n

\n A list of DBInstance instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBInstances action.\n

\n " }, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " } ], "documentation": "\n

\n Returns information about provisioned RDS instances. This API supports pagination.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeDBInstances\n &Version=2013-05-15\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A54%3A55.116Z\n &AWSAccessKeyId=< Your AWS Access ID Key >\n &Signature= < Your Signature >\n \n \n \n \n \n 2011-05-23T06:50:00Z\n mysql\n \n 1\n false\n general-public-license\n available\n 5.1.50\n \n 3306\n
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
\n \n simcoprod01\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n us-east-1a\n 2011-05-23T06:06:43.110Z\n 10\n \n \n default.mysql5.1\n in-sync\n \n \n db.m1.large\n master\n \n \n \n 9135fff3-8509-11e0-bd9b-a7b1ece36d51\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBInstances", "py_input_token": "marker" } }, "DescribeDBLogFiles": { "name": "DescribeDBLogFiles", "input": { "shape_name": "DescribeDBLogFilesMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The customer-assigned name of the DB instance that contains the \n log files you want to list.\n

\n

Constraints:

\n \n ", "required": true }, "FilenameContains": { "shape_name": "String", "type": "string", "documentation": "\n

\n Filters the available log files for log file names that contain the specified string.\n

\n " }, "FileLastWritten": { "shape_name": "Long", "type": "long", "documentation": "\n

\n Filters the available log files for files written since the specified date, in POSIX timestamp format.\n

\n " }, "FileSize": { "shape_name": "Long", "type": "long", "documentation": "\n

\n Filters the available log files for files larger than the specified size.\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response. If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining results can be retrieved.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pagination token provided in the previous request.\n If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "DescribeDBLogFilesResponse", "type": "structure", "members": { "DescribeDBLogFiles": { "shape_name": "DescribeDBLogFilesList", "type": "list", "members": { "shape_name": "DescribeDBLogFilesDetails", "type": "structure", "members": { "LogFileName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the log file for the specified DB instance. \n

\n " }, "LastWritten": { "shape_name": "Long", "type": "long", "documentation": "\n

\n A POSIX timestamp when the last log entry was written. \n

\n " }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size, in bytes, of the log file for the specified DB instance. \n

\n " } }, "documentation": "\n

This data type is used as a response element to DescribeDBLogFiles.

\n ", "xmlname": "DescribeDBLogFilesDetails" }, "documentation": "\n

\n The DB log files returned. \n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional paging token.\n

\n " } }, "documentation": "\n

\n The response from a call to DescribeDBLogFiles.\n

\n " }, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " } ], "documentation": "\n

\n Returns a list of DB log files for the DB instance. \n

\n \n \n \nhttps://rds.amazonaws.com/\n?DBInstanceIdentifier=rrak-mysql\n&MaxRecords=100\n&Version=2013-02-12\n&Action=DescribeDBLogFiles\n&SignatureVersion=4\n&SignatureMethod=HmacSHA256\n&Timestamp=20130327T173621Z\n&X-Amz-Algorithm=AWS4-HMAC-SHA256\n&X-Amz-Date=20130327T173621Z\n&X-Amz-SignedHeaders=Host\n&X-Amz-Expires=20130327T173621Z\n&X-Amz-Credential=\n&X-Amz-Signature=\n \n \n \n \n\n \n \n \n 1364403600000\n error/mysql-error-running.log\n 0\n \n \n 1364338800000\n error/mysql-error-running.log.0\n 0\n \n \n 1364342400000\n error/mysql-error-running.log.1\n 0\n \n 1364346000000\n error/mysql-error-running.log.2\n 0\n \n \n 1364349600000\n error/mysql-error-running.log.3\n 0\n \n \n 1364405700000\n error/mysql-error.log\n 0\n \n \n \n \n d70fb3b3-9704-11e2-a0db-871552e0ef19\n \n\n\n \n \n " }, "DescribeDBParameterGroups": { "name": "DescribeDBParameterGroups", "input": { "shape_name": "DescribeDBParameterGroupsMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a specific DB parameter group to return details for.\n

\n

Constraints:

\n \n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeDBParameterGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBParameterGroupsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupList", "type": "list", "members": { "shape_name": "DBParameterGroup", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the DB parameter group.\n

\n " }, "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the DB parameter group family that\n this DB parameter group is compatible with.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the customer-specified description for this DB parameter group.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the CreateDBParameterGroup action.\n

\n

\n This data type is used as a request parameter in the DeleteDBParameterGroup action,\n and as a response element in the DescribeDBParameterGroups action.\n

\n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n A list of DBParameterGroup instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBParameterGroups action.\n

\n " }, "errors": [ { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " } ], "documentation": "\n

\n Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified,\n the list will contain only the description of the specified DB parameter group.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeDBParameterGroups\n &DBParameterGroupName=myparamsgroup\n &MaxRecords=100\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T17%3A54%3A32.899Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql5.1\n Default parameter group for mysql5.1\n default.mysql5.1\n \n \n mysql5.1\n My DB Param Group\n testdbparamgroup\n \n \n \n \n cb8d9bb4-a02a-11df-bd60-c955b7d6e8e0\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBParameterGroups", "py_input_token": "marker" } }, "DescribeDBParameters": { "name": "DescribeDBParameters", "input": { "shape_name": "DescribeDBParametersMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a specific DB parameter group to return details for.\n

\n

Constraints:

\n \n ", "required": true }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The parameter types to return.\n

\n

Default: All parameter types returned

\n \n

Valid Values: user | system | engine-default

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeDBParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n\n " }, "output": { "shape_name": "DBParameterGroupDetails", "type": "structure", "members": { "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides a description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the source of the parameter value.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the engine specific parameters type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid data type for the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " }, "ApplyMethod": { "shape_name": "ApplyMethod", "type": "string", "enum": [ "immediate", "pending-reboot" ], "documentation": "\n

\n Indicates when to apply parameter updates.\n

\n " } }, "documentation": "\n

\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n A list of Parameter values.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBParameters action.\n

\n " }, "errors": [ { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " } ], "documentation": "\n

\n Returns the detailed parameter list for a particular DB parameter group.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeDBParameters\n &DBParameterGroupName=mydbparametergroup\n &Source=system\n &MaxRecords=100\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T19%3A31%3A42.262Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n /rdsdbbin/mysql\n string\n system\n false\n The MySQL installation base directory.\n static\n basedir\n \n \n 32768\n integer\n system\n true\n The size of the cache to hold the SQL statements for the binary log during a transaction.\n dynamic\n 4096-9223372036854775807\n binlog_cache_size\n \n \n \n \n 8743f2cf-bf41-11de-8c8e-49155882c409\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "Parameters", "py_input_token": "marker" } }, "DescribeDBSecurityGroups": { "name": "DescribeDBSecurityGroups", "input": { "shape_name": "DescribeDBSecurityGroupsMessage", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group to return details for.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeDBSecurityGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSecurityGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroups", "type": "list", "members": { "shape_name": "DBSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the AWS ID of the owner of a specific DB security group.\n

\n " }, "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB security group.\n

\n " }, "DBSecurityGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB security group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the EC2 security group.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the id of the EC2 security group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n Contains a list of EC2SecurityGroup elements.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP range.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n Contains a list of IPRange elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSecurityGroups action.

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n A list of DBSecurityGroup instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBSecurityGroups action.\n

\n " }, "errors": [ { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " } ], "documentation": "\n

\n Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,\n the list will contain only the descriptions of the specified DB security group.\n

\n \n \n https://rds.amazonaws.com/\n ?Action=DescribeDBSecurityGroups\n &Version=2013-05-15\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A40%3A19.926Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n \n authorized\n myec2securitygroup\n 054794666394\n \n \n default\n \n \n 127.0.0.1/30\n authorized\n \n \n 621567473609\n default\n vpc-1ab2c3d4\n \n \n \n My new DBSecurityGroup\n \n \n 192.168.1.1/24\n authorized\n \n \n 621567473609\n mydbsecuritygroup\n vpc-1ab2c3d5\n \n \n \n My new DBSecurityGroup\n \n 621567473609\n mydbsecuritygroup4\n vpc-1ab2c3d6\n \n \n \n \n bbdad154-bf42-11de-86a4-97241dfaadff\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSecurityGroups", "py_input_token": "marker" } }, "DescribeDBSnapshots": { "name": "DescribeDBSnapshots", "input": { "shape_name": "DescribeDBSnapshotsMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier.\n This parameter is not case sensitive.\n

\n

Constraints:

\n \n " }, "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. \n This value is stored as a lowercase string.\n

\n

Constraints:

\n \n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\"\n If not specified, the returned results will include all snapshots types.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeDBSnapshots request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSnapshotMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DBSnapshots": { "shape_name": "DBSnapshotList", "type": "list", "members": { "shape_name": "DBSnapshot", "type": "structure", "members": { "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier for the DB snapshot.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DB instance identifier of the DB instance\n this DB snapshot was created from.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the time (UTC) when the snapshot was taken.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the database engine.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size in gigabytes (GB).\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of this DB snapshot.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine was\n listening on at the time of the snapshot.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB\n instance was located in at the time of the DB snapshot.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the Vpc Id associated with the DB snapshot.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the time (UTC) when the snapshot was taken.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the master username for the DB snapshot.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the version of the database engine.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the type of the DB snapshot.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the option group name for the DB snapshot.\n

\n " }, "PercentProgress": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The percentage of the estimated data that has been transferred.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The region that the DB snapshot was created in or copied from.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSnapshots action.

\n ", "xmlname": "DBSnapshot" }, "documentation": "\n

\n A list of DBSnapshot instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBSnapshots action.\n

\n " }, "errors": [ { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " } ], "documentation": "\n

\n Returns information about DB snapshots. This API supports pagination.\n

\n \n https://rds.amazon.com/\n ?Action=DescribeDBSnapshots\n &MaxRecords=100\n &Version=2013-05-15\n &Timestamp=2011-05-23T06%3A27%3A42.551Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 3306\n 2011-05-23T06:29:03.483Z\n mysql\n available\n us-east-1a\n general-public-license\n 2011-05-23T06:06:43.110Z\n 10\n simcoprod01\n 5.1.50\n mydbsnapshot\n manual\n master\n myoptiongroupname\n \n \n 3306\n 2011-03-11T07:20:24.082Z\n mysql\n available\n us-east-1a\n general-public-license\n 2010-08-04T23:27:36.420Z\n 50\n mydbinstance\n 5.1.49\n mysnapshot1\n manual\n sa\n myoptiongroupname\n \n \n 3306\n 2012-04-02T00:01:24.082Z\n mysql\n available\n us-east-1d\n general-public-license\n 2010-07-16T00:06:59.107Z\n 60\n simcoprod01\n 5.1.47\n rds:simcoprod01-2012-04-02-00-01\n automated\n master\n myoptiongroupname\n \n \n \n \n c4191173-8506-11e0-90aa-eb648410240d\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSnapshots", "py_input_token": "marker" } }, "DescribeDBSubnetGroups": { "name": "DescribeDBSubnetGroups", "input": { "shape_name": "DescribeDBSubnetGroupsMessage", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB subnet group to return details for.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous DescribeDBSubnetGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSubnetGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "DBSubnetGroups": { "shape_name": "DBSubnetGroups", "type": "list", "members": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSubnetGroups action.

\n ", "xmlname": "DBSubnetGroup" }, "documentation": "\n

\n A list of DBSubnetGroup instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeDBSubnetGroups action.\n

\n " }, "errors": [ { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " } ], "documentation": "\n

\n Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified,\n the list will contain only the descriptions of the specified DBSubnetGroup.\n

\n

For an overview of CIDR ranges, go to the \n Wikipedia Tutorial.\n

\n \n \n https://rds.amazonaws.com/\n ?Action=DescribeDBSubnetGroups\n &Version=2013-05-15\n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A40%3A19.926Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 990524496922\n Complete\n description\n subnet_grp1\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n 990524496922\n Complete\n description\n subnet_grp2\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n \n \n 31d0faee-229b-11e1-81f1-df3a2a803dad\n \n \n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSubnetGroups", "py_input_token": "marker" } }, "DescribeEngineDefaultParameters": { "name": "DescribeEngineDefaultParameters", "input": { "shape_name": "DescribeEngineDefaultParametersMessage", "type": "structure", "members": { "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group family.\n

\n ", "required": true }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeEngineDefaultParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "EngineDefaultsWrapper", "type": "structure", "members": { "EngineDefaults": { "shape_name": "EngineDefaults", "type": "structure", "members": { "DBParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB parameter group family which the\n engine default parameters apply to.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous \n EngineDefaults request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides a description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the source of the parameter value.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the engine specific parameters type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid data type for the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " }, "ApplyMethod": { "shape_name": "ApplyMethod", "type": "string", "enum": [ "immediate", "pending-reboot" ], "documentation": "\n

\n Indicates when to apply parameter updates.\n

\n " } }, "documentation": "\n

\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n Contains a list of engine default parameters.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.\n

\n " } } }, "errors": [], "documentation": "\n

\n Returns the default engine and system parameter information for the specified database engine.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeEngineDefaultParameters\n &DBParameterGroupFamily=mysql5.1\n &Version=2013-05-15 \n &MaxRecords=100\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T19%3A10%3A03.510Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n bG93ZXJfY2FzZV90YWJsZV9uYW1lcw==\n mysql5.1\n \n \n boolean\n engine-default\n false\n Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded\n static\n 0,1\n allow-suspicious-udfs\n \n \n integer\n engine-default\n true\n Intended for use with master-to-master replication, and can be used to control the operation of AUTO_INCREMENT columns\n dynamic\n 1-65535\n auto_increment_increment\n \n \n integer\n engine-default\n true\n Determines the starting point for the AUTO_INCREMENT column value\n dynamic\n 1-65535\n auto_increment_offset\n \n \n \n \n 6c1341eb-a124-11df-bf5c-973b09643c5d\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "EngineDefaults", "py_input_token": "marker" } }, "DescribeEventCategories": { "name": "DescribeEventCategories", "input": { "shape_name": "DescribeEventCategoriesMessage", "type": "structure", "members": { "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of source that will be generating the events.\n

\n

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "EventCategoriesMessage", "type": "structure", "members": { "EventCategoriesMapList": { "shape_name": "EventCategoriesMapList", "type": "list", "members": { "shape_name": "EventCategoriesMap", "type": "structure", "members": { "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type that the returned categories belong to

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

The event categories for the specified source type

\n " } }, "wrapper": true, "documentation": " \n

Contains the results of a successful invocation of the DescribeEventCategories action.

\n ", "xmlname": "EventCategoriesMap" }, "documentation": "\n

A list of EventCategoriesMap data types.

\n " } }, "documentation": " \n

Data returned from the DescribeEventCategories action.

\n " }, "errors": [], "documentation": "\n

Displays a list of categories for all event source types, or, if specified, for a specified source type.\n You can see a list of the event categories and source types \n in the \n Events topic in the Amazon RDS User Guide.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=DescribeEventCategories\n &SourceType=db-instance\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T013452Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n \n db-instance\n \n failover\n low storage\n maintenance\n recovery\n restoration\n deletion\n configuration change\n failover\n availability\n creation\n backup\n notification\n \n \n \n \n \n ea3bf54b-68ea-11e2-bd13-a92da73b3119\n \n\n \n \n \n \n " }, "DescribeEventSubscriptions": { "name": "DescribeEventSubscriptions", "input": { "shape_name": "DescribeEventSubscriptionsMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the RDS event notification subscription you want to describe.

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

\n \n \n " } }, "documentation": " \n

\n " }, "output": { "shape_name": "EventSubscriptionsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "EventSubscriptionsList": { "shape_name": "EventSubscriptionsList", "type": "list", "members": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n ", "xmlname": "EventSubscription" }, "documentation": "\n

A list of EventSubscriptions data types.

\n " } }, "documentation": " \n

Data returned by the DescribeEventSubscriptions action.

\n " }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The subscription name does not exist.

\n " } ], "documentation": "\n

Lists all the subscription descriptions for a customer account. The description for a subscription includes\n SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.\n

\n

If you specify a SubscriptionName, lists the description for that subscription.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=DescribeEventSubscriptions\n &MaxRecords=100\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T004543Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n true\n 012345678901\n active\n 2013-01-28 00:29:23.736\n EventSubscription01\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n true\n 012345678901\n active\n 2013-01-28 00:29:42.851\n EventSubscription02\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n \n 0ce48079-68e4-11e2-91fe-5daa8e68c7d4\n \n\n \n \n ", "pagination": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EventSubscriptionsList", "py_input_token": "marker" } }, "DescribeEvents": { "name": "DescribeEvents", "input": { "shape_name": "DescribeEventsMessage", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the event source for which events\n will be returned. If not specified,\n then all sources are included in the response.\n

\n

Constraints:

\n \n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "db-instance", "db-parameter-group", "db-security-group", "db-snapshot" ], "documentation": "\n

\n The event source to retrieve events for.\n If no value is specified, all events are returned.\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

\n " }, "EndTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

\n " }, "Duration": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of minutes to retrieve events for.\n

\n

Default: 60

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

\n A list of event categories that trigger notifications for a event notification subscription.\n

\n \n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "EventsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous \n Events request.\n If this parameter is specified, the response includes\n only records beyond the marker, \n up to the value specified by MaxRecords .\n

\n " }, "Events": { "shape_name": "EventList", "type": "list", "members": { "shape_name": "Event", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the identifier for the source of the event.\n

\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "db-instance", "db-parameter-group", "db-security-group", "db-snapshot" ], "documentation": "\n

\n Specifies the source type for this event.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the text of this event.\n

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

\n Specifies the category for the event.\n

\n " }, "Date": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the date and time of the event.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeEvents action.\n

\n ", "xmlname": "Event" }, "documentation": "\n

\n A list of Event instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeEvents action.\n

\n " }, "errors": [], "documentation": "\n

\n Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter\n groups for the past 14 days. Events specific to a particular DB instance, DB security group,\n database snapshot, or DB parameter group can be obtained by providing the name as a parameter.\n By default, the past hour of events are returned.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeEvents\n &Duration=1440\n &MaxRecords=100\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T20%3A00%3A44.420Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n Applied change to security group\n db-security-group\n 2010-08-11T17:12:52.860Z\n mydbsecuritygroup\n \n \n Database instance created\n db-instance\n 2010-08-11T18:10:15.269Z\n mydbinstance3\n \n \n Backing up database instance\n db-instance\n 2010-08-11T18:10:34.690Z\n mydbinstance3\n \n \n Backing up DB instance\n db-instance\n 2010-08-11T18:25:52.263Z\n mynewdbinstance\n \n \n Creating user snapshot\n db-snapshot\n 2010-08-11T18:25:52.263Z\n mynewdbsnapshot3\n \n \n \n \n 95b948cd-bf45-11de-86a4-97241dfaadff\n \n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "Events", "py_input_token": "marker" } }, "DescribeOptionGroupOptions": { "name": "DescribeOptionGroupOptions", "input": { "shape_name": "DescribeOptionGroupOptionsMessage", "type": "structure", "members": { "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n A required parameter. Options available for the given Engine name will be described.\n

\n ", "required": true }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n If specified, filters the results to include only options for the specified major engine version.\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n \n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "OptionGroupOptionsMessage", "type": "structure", "members": { "OptionGroupOptions": { "shape_name": "OptionGroupOptionsList", "type": "list", "members": { "shape_name": "OptionGroupOption", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option.\n

\n " }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Engine name that this option can be applied to.\n

\n " }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the major engine version that the option is available for.\n

\n " }, "MinimumRequiredMinorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The minimum required engine version for the option to be applied.\n

\n " }, "PortRequired": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether the option requires a port.\n

\n " }, "DefaultPort": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n If the option requires a port, specifies the default port for the option.\n

\n " }, "OptionsDependedOn": { "shape_name": "OptionsDependedOn", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "OptionName" }, "documentation": "\n

\n List of all options that are prerequisites for this option.\n

\n " }, "Persistent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.\n

\n " }, "Permanent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.\n

\n " }, "OptionGroupOptionSettings": { "shape_name": "OptionGroupOptionSettingsList", "type": "list", "members": { "shape_name": "OptionGroupOptionSetting", "type": "structure", "members": { "SettingName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group option.\n

\n " }, "SettingDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option group option.\n

\n " }, "DefaultValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The default value for the option group option.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB engine specific parameter type for the option group option.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the acceptable values for the option group option.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value where true indicates that this option group option can be changed from the default value.\n

\n " } }, "documentation": " \n

\n option group option settings are used to display settings available for each option \n with their default values and other information. These values are used with the \n DescribeOptionGroupOptions action.\n

\n ", "xmlname": "OptionGroupOptionSetting" }, "documentation": " \n

\n Specifies the option settings that are available (and the default value) for each option in an option group.\n

\n " } }, "documentation": "\n

\n Available option.\n

\n ", "xmlname": "OptionGroupOption" }, "documentation": "\n

\n List of available option group options.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.

\n " } }, "documentation": "\n

\n

\n " }, "errors": [], "documentation": "\n

\n Describes all available options. \n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeOptionGroupOptions\n &EngineName=oracle-se1\n &MajorEngineVersion=11.2\n \n \n \n \n 11.2\n true\n \n Oracle Enterprise Manager\n 1158\n OEM\n oracle-se1\n 0.2.v3\n false\n false\n \n \n \n \n d9c8f6a1-84c7-11e1-a264-0b23c28bc344\n \n \n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OptionGroupOptions", "py_input_token": "marker" } }, "DescribeOptionGroups": { "name": "DescribeOptionGroups", "input": { "shape_name": "DescribeOptionGroupsMessage", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous DescribeOptionGroups request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n \n " }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Filters the list of option groups to only include groups associated with a specific database engine.\n

\n " }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.\n

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "OptionGroups", "type": "structure", "members": { "OptionGroupsList": { "shape_name": "OptionGroupsList", "type": "list", "members": { "shape_name": "OptionGroup", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the option group.\n

\n " }, "OptionGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the option group.\n

\n " }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Engine name that this option group can be applied to.\n

\n " }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the major engine version associated with this option group.\n

\n " }, "Options": { "shape_name": "OptionsList", "type": "list", "members": { "shape_name": "Option", "type": "structure", "members": { "OptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option.\n

\n " }, "OptionDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option.\n

\n " }, "Persistent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicate if this option is persistent.\n

\n " }, "Permanent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicate if this option is permanent.

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n If required, the port configured for this option to use.\n

\n " }, "OptionSettings": { "shape_name": "OptionSettingConfigurationList", "type": "list", "members": { "shape_name": "OptionSetting", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option that has settings that you can set.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current value of the option setting.\n

\n " }, "DefaultValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The default value of the option setting.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option setting.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB engine specific parameter type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the option setting.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allowed values of the option setting.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A Boolean value that, when true, indicates the option setting can be modified from the default.\n

\n " }, "IsCollection": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the option setting is part of a collection.\n

\n " } }, "documentation": "\n

\n Option settings are the actual settings being applied or configured \n for that option. It is used when you modify an option group or describe \n option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting \n called SQLNET.ENCRYPTION_SERVER that can have several different values.\n

\n ", "xmlname": "OptionSetting" }, "documentation": "\n

\n The option settings for this option. \n

\n " }, "DBSecurityGroupMemberships": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n If the option requires access to a port, then this DB security group allows access to the port. \n

\n " }, "VpcSecurityGroupMemberships": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n If the option requires access to a port, then this VPC security group allows access to the port.\n

\n " } }, "documentation": "\n

\n Option details.\n

\n", "xmlname": "Option" }, "documentation": "\n

\n Indicates what options are available in the option group.\n

\n " }, "AllowsVpcAndNonVpcInstanceMemberships": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

\n " } }, "wrapper": true, "documentation": "\n

\n

\n ", "xmlname": "OptionGroup" }, "documentation": "\n

\n List of option groups.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": " \n

An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n List of option groups.\n

\n " }, "errors": [ { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " } ], "documentation": "\n

\n Describes the available option groups.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeOptionGroups\n &OptionGroupName=myoptiongroup\n &MaxRecords=100\n \n \n \n \n 11.2\n myoptiongroup\n oracle-se1\n Test option group\n \n \n \n \n \n 6088823d-84c8-11e1-a264-0b23c28bc344\n \n \n https://rds.amazonaws.com/\n ?Action=DescribeOptionGroups\n &MaxRecords=100\n \n \n \n \n 11.2\n myoptiongroup\n oracle-se1\n Test option group\n \n \n \n 11.2\n default:oracle-se1-11-2\n oracle-se1\n Default option group.\n \n \n \n \n \n e4b234d9-84d5-11e1-87a6-71059839a52b\n \n \n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OptionGroupsList", "py_input_token": "marker" } }, "DescribeOrderableDBInstanceOptions": { "name": "DescribeOrderableDBInstanceOptions", "input": { "shape_name": "DescribeOrderableDBInstanceOptionsMessage", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the engine to retrieve DB instance options for.

\n ", "required": true }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

\n " }, "Vpc": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining\n results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous\n DescribeOrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords .\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "OrderableDBInstanceOptionsMessage", "type": "structure", "members": { "OrderableDBInstanceOptions": { "shape_name": "OrderableDBInstanceOptionsList", "type": "list", "members": { "shape_name": "OrderableDBInstanceOption", "type": "structure", "members": { "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The engine type of the orderable DB instance.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The engine version of the orderable DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance Class for the orderable DB instance \n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n The license model for the orderable DB instance. \n

\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZoneList", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n ", "xmlname": "AvailabilityZone" }, "documentation": "\n

\n A list of availability zones for the orderable DB instance. \n

\n " }, "MultiAZCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this orderable DB instance is multi-AZ capable. \n

\n " }, "ReadReplicaCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this orderable DB instance can have a read replica.\n

\n " }, "Vpc": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this is a VPC orderable DB instance.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains a list of available options for a DB instance \n

\n

\n This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.\n

\n ", "xmlname": "OrderableDBInstanceOption" }, "documentation": "\n

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous \n OrderableDBInstanceOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n \n up to the value specified by MaxRecords .\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action. \n

\n " }, "errors": [], "documentation": "\n

Returns a list of orderable DB instance options for the specified engine.

\n \n https://rds.amazonaws.com/\n ?Action=DescribeOrderableDBInstanceOptions\n &Engine=mysql\n &MaxRecords=100\n &Version=2013-05-15\n &Timestamp=2011-05-23T07%3A49%3A17.749Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n true\n mysql\n general-public-license\n true\n 5.1.45\n db.m1.large\n \n \n us-east-1a\n yes\n \n \n us-east-1b\n no\n \n \n us-east-1d\n yes\n \n \n \n \n true\n mysql\n general-public-license\n true\n 5.1.45\n db.m1.small\n \n \n us-east-1a\n yes\n \n \n us-east-1b\n yes\n \n \n us-east-1d\n yes\n \n \n \n \n true\n mysql\n general-public-license\n true\n 5.1.45\n db.m1.xlarge\n \n \n us-east-1a\n yes\n \n \n us-east-1b\n yes\n \n \n us-east-1d\n yes\n \n \n \n \n true\n mysql\n general-public-license\n true\n 5.1.45\n db.m2.2xlarge\n \n \n us-east-1a\n yes\n \n \n us-east-1b\n yes\n \n \n us-east-1d\n yes\n \n \n \n \n true\n mysql\n general-public-license\n true\n 5.1.45\n db.m2.4xlarge\n \n \n us-east-1a\n yes\n \n \n us-east-1b\n no\n \n \n us-east-1d\n no\n \n \n \n \n \n \n 2a0406d7-8511-11e0-90aa-eb648410240d\n \n\n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OrderableDBInstanceOptions", "py_input_token": "marker" } }, "DescribeReservedDBInstances": { "name": "DescribeReservedDBInstances", "input": { "shape_name": "DescribeReservedDBInstancesMessage", "type": "structure", "members": { "ReservedDBInstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The reserved DB instance identifier filter value.\n Specify this parameter to show only the reservation\n that matches the specified reservation ID.\n

\n " }, "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier filter value.\n Specify this parameter to show only purchased reservations\n matching the specified offering identifier.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance class filter value.\n Specify this parameter to show only those reservations\n matching the specified DB instances class.\n

\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\n

\n The duration filter value, specified in years or seconds.\n Specify this parameter to show only reservations for this duration.\n

\n

Valid Values: 1 | 3 | 31536000 | 94608000

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The product description filter value.\n Specify this parameter to show only those reservations\n matching the specified product description.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering type filter value.\n Specify this parameter to show only the available\n offerings matching the specified offering type.\n

\n

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n The Multi-AZ filter value. Specify this parameter to show only\n those reservations matching the specified Multi-AZ parameter.\n

\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "FilterName": { "shape_name": "String", "type": "string", "documentation": "\n

This parameter is not currently supported.

\n ", "required": true }, "FilterValue": { "shape_name": "FilterValueList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n

This parameter is not currently supported.

\n ", "required": true } }, "documentation": "\n \n ", "xmlname": "Filter" }, "documentation": "\n

This parameter is not currently supported.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

" }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ReservedDBInstanceMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "ReservedDBInstances": { "shape_name": "ReservedDBInstanceList", "type": "list", "members": { "shape_name": "ReservedDBInstance", "type": "structure", "members": { "ReservedDBInstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier for the reservation.\n

\n " }, "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance class for the reserved DB instance.\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time the reservation started.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration of the reservation in seconds.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The fixed price charged for this reserved DB instance.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The hourly price charged for this reserved DB instance.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

\n The currency code for the reserved DB instance.\n

\n " }, "DBInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of reserved DB instances.\n

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the reserved DB instance.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": " \n

\n The offering type of this reserved DB instance. \n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the reservation applies to Multi-AZ deployments.\n

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n The state of the reserved DB instance.\n

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The amount of the recurring charge.\n

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

\n The frequency of the recurring charge.\n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.\n

\n ", "xmlname": "RecurringCharge" }, "documentation": " \n

\n The recurring price charged to run this reserved DB instance. \n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.\n

\n ", "xmlname": "ReservedDBInstance" }, "documentation": "\n

\n A list of reserved DB instances.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeReservedDBInstances action.\n

\n " }, "errors": [ { "shape_name": "ReservedDBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified reserved DB Instance not found.\n

\n " } ], "documentation": "\n

\n Returns information about reserved DB instances for this account,\n or about a specified reserved DB instance.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeReservedDBInstances\n &ReservedDBInstanceId=customerSpecifiedID\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2012-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n Medium Utilization\n USD\n \n mysql\n 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f\n false\n active\n myreservationid\n 1\n 2010-12-15T00:25:14.131Z\n 31536000\n 227.5\n 0.046\n db.m1.small\n \n \n \n c695119b-2961-11e1-bd06-6fe008f046c3\n \n\n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "ReservedDBInstances", "py_input_token": "marker" } }, "DescribeReservedDBInstancesOfferings": { "name": "DescribeReservedDBInstancesOfferings", "input": { "shape_name": "DescribeReservedDBInstancesOfferingsMessage", "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier filter value.\n Specify this parameter to show only the available offering\n that matches the specified reservation identifier.\n

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance class filter value.\n Specify this parameter to show only the available offerings\n matching the specified DB instance class.\n

\n " }, "Duration": { "shape_name": "String", "type": "string", "documentation": "\n

\n Duration filter value, specified in years or seconds.\n Specify this parameter to show only reservations for this duration.\n

\n

Valid Values: 1 | 3 | 31536000 | 94608000

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Product description filter value.\n Specify this parameter to show only the available\n offerings matching the specified product description.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering type filter value.\n Specify this parameter to show only the available\n offerings matching the specified offering type.\n

\n

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n The Multi-AZ filter value.\n Specify this parameter to show only the available\n offerings matching the specified Multi-AZ parameter.\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a pagination token called a marker is\n included in the response so that the following results can be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

" }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ReservedDBInstancesOfferingMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " }, "ReservedDBInstancesOfferings": { "shape_name": "ReservedDBInstancesOfferingList", "type": "list", "members": { "shape_name": "ReservedDBInstancesOffering", "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance class for the reserved DB instance.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration of the offering in seconds.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The fixed price charged for this offering.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The hourly price charged for this offering.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

\n The currency code for the reserved DB instance offering.\n

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database engine used by the offering.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": " \n

\n The offering type. \n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the offering applies to Multi-AZ deployments.\n

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The amount of the recurring charge.\n

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

\n The frequency of the recurring charge.\n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.\n

\n ", "xmlname": "RecurringCharge" }, "documentation": " \n

\n The recurring price charged to run this reserved DB instance. \n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.\n

\n\n ", "xmlname": "ReservedDBInstancesOffering" }, "documentation": "\n

\n A list of reserved DB instance offerings.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action. \n

\n " }, "errors": [ { "shape_name": "ReservedDBInstancesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified offering does not exist.\n

\n " } ], "documentation": "\n

\n Lists available reserved DB instance offerings.\n

\n \n https://rds.amazonaws.com/\n ?Action=DescribeReservedDBInstancesOfferings\n &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-12-18T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 31536000\n Heavy Utilization\n USD\n \n \n Hourly\n 0.123\n \n \n 162.0\n mysql\n 0.0\n false\n SampleOfferingId\n db.m1.small\n \n \n \n \n 521b420a-2961-11e1-bd06-6fe008f046c3\n \n\n\n\n \n ", "pagination": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "ReservedDBInstancesOfferings", "py_input_token": "marker" } }, "DownloadDBLogFilePortion": { "name": "DownloadDBLogFilePortion", "input": { "shape_name": "DownloadDBLogFilePortionMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The customer-assigned name of the DB instance that contains the \n log files you want to list.\n

\n

Constraints:

\n \n ", "required": true }, "LogFileName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the log file to be downloaded.\n

\n ", "required": true }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pagination token provided in the previous request.\n If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.\n

\n " }, "NumberOfLines": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of lines remaining to be downloaded.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "DownloadDBLogFilePortionDetails", "type": "structure", "members": { "LogFileData": { "shape_name": "String", "type": "string", "documentation": "\n

\n Entries from the specified log file. \n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional pagination token provided by a previous \n DownloadDBLogFilePortion request. \n

\n " }, "AdditionalDataPending": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that if true, indicates there is more data to be downloaded. \n

\n " } }, "documentation": "\n

This data type is used as a response element to DownloadDBLogFilePortion.

\n " }, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " } ], "documentation": "\n

\n Downloads the last line of the specified log file. \n

\n \n \n https://rds.amazonaws.com/\n?DBInstanceIdentifier=rra-mysql\n&MaxRecords=100\n&Version=2013-05-15\n&Action=DescribeDBLogFiles\n&SignatureVersion=4\n&SignatureMethod=HmacSHA256\n&Timestamp=20130327T173621Z\n&X-Amz-Algorithm=AWS4-HMAC-SHA256\n&X-Amz-Date=20130327T173621Z\n&X-Amz-SignedHeaders=Host\n&X-Amz-Expires=20130327T173621Z\n&X-Amz-Credential=\n&X-Amz-Signature=\n \n \n \n \n \n 1364403600000\n error/mysql-error-running.log\n 0\n \n \n 1364338800000\n error/mysql-error-running.log.0\n 0\n \n \n 1364342400000\n error/mysql-error-running.log.1\n 0\n \n \n 1364371200000\n error/mysql-error-running.log.9\n 0\n \n \n 1364405700000\n error/mysql-error.log\n 0\n \n \n \n \n d70fb3b3-9704-11e2-a0db-871552e0ef19\n \n\n \n \n " }, "ListTagsForResource": { "name": "ListTagsForResource", "input": { "shape_name": "ListTagsForResourceMessage", "type": "structure", "members": { "ResourceName": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

\n ", "required": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "TagListMessage", "type": "structure", "members": { "TagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

List of tags returned by the ListTagsForResource operation.

\n " } }, "documentation": "\n

\n " }, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " } ], "documentation": "\n

Lists all tags on an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources.

\n " }, "ModifyDBInstance": { "name": "ModifyDBInstance", "input": { "shape_name": "ModifyDBInstanceMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier.\n This value is stored as a lowercase string. \n

\n

Constraints:

\n \n \n ", "required": true }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The new storage capacity of the RDS instance.\n Changing this parameter does not result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request.\n

\n

MySQL

\n

Default: Uses existing setting

\n

Valid Values: 5-1024

\n

Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

Type: Integer

\n

Oracle

\n

Default: Uses existing setting

\n

Valid Values: 10-1024

\n

Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

SQL Server

\n

Cannot be modified.

\n

\n If you choose to migrate your DB instance from using standard storage to \n using Provisioned IOPS, or from using Provisioned IOPS to using standard \n storage, the process can take time. The duration of the migration depends \n on several factors such as database load, storage size, storage type \n (standard or Provisioned IOPS), amount of IOPS provisioned (if any), \n and the number of prior scale storage operations. Typical migration times \n are under 24 hours, but the process can take up to several days in some \n cases. During the migration, the DB instance will be available for use, \n but may experience performance degradation. While the migration takes \n place, nightly backups for the instance will be suspended. No other Amazon \n RDS operations can take place for the instance, including modifying the \n instance, rebooting the instance, deleting the instance, creating a read \n replica for the instance, and creating a DB snapshot of the instance. \n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular \n DB engine, use the DescribeOrderableDBInstanceOptions action.\n

\n

\n Passing a value for this parameter causes an outage during the change and\n is applied during the next maintenance window,\n unless the ApplyImmediately parameter is specified\n as true for this request.\n

\n

Default: Uses existing setting

\n

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge

\n \n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "DBSecurityGroupName" }, "documentation": "\n

\n A list of DB security groups to authorize on this DB instance.\n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n

\n

Constraints:

\n \n " }, "VpcSecurityGroupIds": { "shape_name": "VpcSecurityGroupIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcSecurityGroupId" }, "documentation": "\n

\n A list of EC2 VPC security groups to authorize on this DB instance.\n This change is asynchronously applied as soon as possible.\n

\n

Constraints:

\n \n " }, "ApplyImmediately": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether or not the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance.\n

\n

\n If this parameter is passed as false, changes to the\n DB instance are applied on the next call to\n RebootDBInstance,\n the next maintenance reboot, or the next failure reboot,\n whichever occurs first. See each parameter to determine when a change is applied.\n

\n

Default: false

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

\n

\n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n

\n

Default: Uses existing setting

\n

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 \n alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

\n \n Amazon RDS API actions never return the password, so this action provides a way to \n regain access to a master instance user if the password is lost.\n \n " }, "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group to apply to this DB instance. \n Changing this parameter does not result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request.\n

\n

Default: Uses existing setting

\n

Constraints: The DB parameter group must be in the same DB \n parameter group family as this DB instance.

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days to retain automated backups.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n

\n

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. \n These changes are applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request. If you change the parameter from one non-zero value to another \n non-zero value, the change is asynchronously applied as soon as possible.

\n \n

Default: Uses existing setting

\n

Constraints:

\n \n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n as determined by the BackupRetentionPeriod. \n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n

\n

Constraints:

\n \n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which system maintenance can occur,\n which may result in an outage. Changing this parameter does not result in an outage, except in the following situation,\n and the change is asynchronously applied as soon as possible.\n If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this\n parameter will cause a reboot of the DB instance.\n If moving this window to the current time,\n there must be at least 30 minutes between the current time and\n end of the window to ensure pending changes are applied.\n

\n

Default: Uses existing setting

\n

Format: ddd:hh24:mi-ddd:hh24:mi

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment. \n Changing this parameter does not result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request.\n

\n

Constraints: Cannot be specified if the DB instance is a read replica.

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request.\n

\n

\n For major version upgrades, if a non-default DB parameter group is currently in use,\n a new DB parameter group in the DB parameter group family\n for the new engine version must be specified.\n The new DB parameter group can be the default for that DB parameter group family.\n

\n

Example: 5.1.42

\n " }, "AllowMajorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that major version upgrades are allowed. \n Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.\n

\n

Constraints: This parameter must be set to true when \n specifying a value for the EngineVersion parameter that is \n a different major version than the DB instance's current version.

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that minor version upgrades will be applied automatically\n to the DB instance during the maintenance window. \n Changing this parameter does not result in an outage except in the following case \n and the change is asynchronously applied as soon as possible.\n An outage will result if this parameter is set to true during the maintenance window, \n and a newer minor version is available, and RDS has enabled auto patching for that engine version.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The new Provisioned IOPS (I/O operations per second) value for the RDS instance. \n Changing this parameter does not result in an outage and\n the change is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request.\n

\n

Default: Uses existing setting

\n

Constraints: Value supplied must be at least 10% greater than the current value. \n Values that are not at least 10% greater than the existing value are rounded up \n so that they are 10% greater than the current value.

\n

Type: Integer

\n

\n If you choose to migrate your DB instance from using standard storage to \n using Provisioned IOPS, or from using Provisioned IOPS to using standard \n storage, the process can take time. The duration of the migration depends \n on several factors such as database load, storage size, storage type \n (standard or Provisioned IOPS), amount of IOPS provisioned (if any), \n and the number of prior scale storage operations. Typical migration times \n are under 24 hours, but the process can take up to several days in some \n cases. During the migration, the DB instance will be available for use, \n but may experience performance degradation. While the migration takes \n place, nightly backups for the instance will be suspended. No other Amazon \n RDS operations can take place for the instance, including modifying the \n instance, rebooting the instance, deleting the instance, creating a read \n replica for the instance, and creating a DB snapshot of the instance. \n

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates that the DB instance should be associated with the specified option group. \n Changing this parameter does not result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is set\n to true for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n

\n

\n \n Permanent options, such as the TDE option for Oracle Advanced Security TDE, \n cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance\n

\n \n " }, "NewDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new DB instance identifier for the DB instance when renaming a DB\n Instance.\n This value is stored as a lowercase string. \n

\n

Constraints:

\n \n \n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "InvalidDBSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB security group does not allow deletion.\n

\n " }, { "shape_name": "DBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a DB instance with the given identifier.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " }, { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " }, { "shape_name": "InsufficientDBInstanceCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified DB instance class is not available in the specified Availability Zone.\n

\n " }, { "shape_name": "StorageQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the\n allowed amount of storage available across all DB instances.\n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n DB subnet group does not cover all Availability Zones after it is created because users' change.\n

\n " }, { "shape_name": "ProvisionedIopsNotAvailableInAZFault", "type": "structure", "members": {}, "documentation": "\n

\n Provisioned IOPS not available in the specified Availability Zone.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " }, { "shape_name": "DBUpgradeDependencyFailureFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB upgrade failed because a resource the DB depends on could not be modified.\n

\n " } ], "documentation": "\n

\n Modify settings for a DB instance. You can change one\n or more database configuration parameters by specifying these parameters and the new values in the\n request.\n

\n \n https://rds.amazonaws.com/\n ?Action=ModifyDBInstance\n &DBInstanceIdentifier=simcoprod01\n &AllocatedStorage=50\n &Version=2013-05-15\n &ApplyImmediately=false\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T08%3A02%3A09.574Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n 2011-05-23T08:00:00Z\n mysql\n \n 50\n \n 1\n false\n general-public-license\n available\n 5.1.50\n \n 3306\n
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
\n \n simcoprod01\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n us-east-1a\n 2011-05-23T06:06:43.110Z\n 10\n db.m1.large\n master\n \n \n \n f61a020f-8512-11e0-90aa-eb648410240d\n \n\n \n " }, "ModifyDBParameterGroup": { "name": "ModifyDBParameterGroup", "input": { "shape_name": "ModifyDBParameterGroupMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n

Constraints:

\n \n ", "required": true }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides a description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the source of the parameter value.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the engine specific parameters type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid data type for the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " }, "ApplyMethod": { "shape_name": "ApplyMethod", "type": "string", "enum": [ "immediate", "pending-reboot" ], "documentation": "\n

\n Indicates when to apply parameter updates.\n

\n " } }, "documentation": "\n

\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n An array of parameter names, values, and the apply method\n for the parameter update. At least one parameter name,\n value, and apply method must be supplied; subsequent arguments are optional.\n A maximum of 20 parameters may be modified in a single request.\n

\n

Valid Values (for the application method): immediate | pending-reboot

\n You can use the immediate value with dynamic parameters only. \n You can use the pending-reboot value for both dynamic and static parameters, \n and changes are applied when DB instance reboots. \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBParameterGroupNameMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.\n

\n " }, "errors": [ { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " }, { "shape_name": "InvalidDBParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB parameter group cannot be deleted because it is in use.\n

\n " } ], "documentation": "\n

\n Modifies the parameters of a DB parameter group. To modify more than one parameter,\n submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20\n parameters can be modified in a single request.\n

\n \n

\n The apply-immediate method can be used only for\n dynamic parameters; the pending-reboot method can be used\n with MySQL and Oracle DB instances for either dynamic or static parameters. For \n Microsoft SQL Server DB instances, the pending-reboot method can \n be used only for static parameters. \n

\n \n \n https://rds.amazonaws.com/\n ?Action=ModifyDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Parameters.member.1.ParameterName=max_user_connections\n &Parameters.member.1.ParameterValue=24\n &Parameters.member.1.ApplyMethod=pending-reboot\n &Parameters.member.2.ParameterName=max_allowed_packet\n &Parameters.member.2.ParameterValue=1024\n &Parameters.member.2.ApplyMethod=immediate\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-11T21%3A25%3A00.686Z\n &AWSAccessKeyId=\n &Signature=\n \n \n mydbparametergroup\n \n \n 5ba91f97-bf51-11de-bf60-ef2e377db6f3\n \n\n \n " }, "ModifyDBSubnetGroup": { "name": "ModifyDBSubnetGroup", "input": { "shape_name": "ModifyDBSubnetGroupMessage", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the DB subnet group.\n This value is stored as a lowercase string.\n

\n

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

\n \n

Example: mySubnetgroup

\n ", "required": true }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description for the DB subnet group.\n

\n " }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

\n The EC2 subnet IDs for the DB subnet group.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSubnetGroupWrapper", "type": "structure", "members": { "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSubnetGroups action.

\n " } } }, "errors": [ { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of subnets in a DB subnet groups.\n

\n " }, { "shape_name": "SubnetAlreadyInUse", "type": "structure", "members": {}, "documentation": "\n

\n The DB subnet is already in use in the Availability Zone.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " } ], "documentation": "\n

\n Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.\n

\n \n https://rds.amazonaws.com/\n ?Action=ModifyDBSubnetGroup\n &DBSubnetGroupName=mydbsubnetgroup\n &DBSubnetGroupDescription=My%20modified%20DBSubnetGroup\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T18%3A14%3A49.482Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n 990524496922\n Complete\n My modified DBSubnetGroup\n mydbsubnetgroup\n \n \n Active\n subnet-7c5b4115\n \n us-east-1c\n \n \n \n Active\n subnet-7b5b4112\n \n us-east-1b\n \n \n \n Active\n subnet-3ea6bd57\n \n us-east-1d\n \n \n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n \n " }, "ModifyEventSubscription": { "name": "ModifyEventSubscription", "input": { "shape_name": "ModifyEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the RDS event notification subscription.

\n ", "required": true }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create \n a topic and subscribe to it.\n

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, \n you would set this parameter to db-instance. if this value is not specified, all events are returned.\n

\n

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

\n A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType \n in the Events topic in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.\n

\n " }, "Enabled": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n A Boolean value; set to true to activate the subscription.\n

\n " } }, "documentation": " \n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n " } } }, "errors": [ { "shape_name": "EventSubscriptionQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

You have reached the maximum number of event subscriptions.

\n " }, { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The subscription name does not exist.

\n " }, { "shape_name": "SNSInvalidTopicFault", "type": "structure", "members": {}, "documentation": "\n

SNS has responded that there is a problem with the SND topic specified.

\n " }, { "shape_name": "SNSNoAuthorizationFault", "type": "structure", "members": {}, "documentation": "\n

You do not have permission to publish to the SNS topic ARN.

\n " }, { "shape_name": "SNSTopicArnNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The SNS topic ARN does not exist.

\n " }, { "shape_name": "SubscriptionCategoryNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The supplied category does not exist.

\n " } ], "documentation": "\n

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change \n source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

\n

You can see a list of the event categories for a given SourceType \n in the Events topic in the Amazon RDS User Guide \n or by using the DescribeEventCategories action.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=ModifyEventSubscription\n &SubscriptionName=EventSubscription01\n &EventCategories.member.1=creation\n &EventCategories.member.2=deletion\n &SourceType=db-instance\n &Enabled=true\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T005359Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n \n \n true\n 012345678901\n db-instance\n modifying\n 2013-01-28 00:29:23.736\n \n creation\n deletion\n \n EventSubscription01\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n 34907d48-68e5-11e2-98ef-2b071ac20a57\n \n \n \n \n " }, "ModifyOptionGroup": { "name": "ModifyOptionGroup", "input": { "shape_name": "ModifyOptionGroupMessage", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group to be modified.\n

\n

\n \n Permanent options, such as the TDE option for Oracle Advanced Security TDE, \n cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance\n

\n \n ", "required": true }, "OptionsToInclude": { "shape_name": "OptionConfigurationList", "type": "list", "members": { "shape_name": "OptionConfiguration", "type": "structure", "members": { "OptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The configuration of options to include in a group. \n

\n ", "required": true }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The optional port for the option.\n

\n " }, "DBSecurityGroupMemberships": { "shape_name": "DBSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "DBSecurityGroupName" }, "documentation": "\n

\n A list of DBSecurityGroupMemebrship name strings used for this option. \n

\n " }, "VpcSecurityGroupMemberships": { "shape_name": "VpcSecurityGroupIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcSecurityGroupId" }, "documentation": "\n

\n A list of VpcSecurityGroupMemebrship name strings used for this option. \n

\n " }, "OptionSettings": { "shape_name": "OptionSettingsList", "type": "list", "members": { "shape_name": "OptionSetting", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option that has settings that you can set.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current value of the option setting.\n

\n " }, "DefaultValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The default value of the option setting.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option setting.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB engine specific parameter type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the option setting.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allowed values of the option setting.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A Boolean value that, when true, indicates the option setting can be modified from the default.\n

\n " }, "IsCollection": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the option setting is part of a collection.\n

\n " } }, "documentation": "\n

\n Option settings are the actual settings being applied or configured \n for that option. It is used when you modify an option group or describe \n option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting \n called SQLNET.ENCRYPTION_SERVER that can have several different values.\n

\n ", "xmlname": "OptionSetting" }, "documentation": " \n

\n The option settings to include in an option group.\n

\n " } }, "documentation": " \n

\n A list of all available options\n

\n ", "xmlname": "OptionConfiguration" }, "documentation": "\n

\n Options in this list are added to the option group or, if already present,\n the specified configuration is used to update the existing configuration.\n

\n " }, "OptionsToRemove": { "shape_name": "OptionNamesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

\n Options in this list are removed from the option group.\n

\n " }, "ApplyImmediately": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether the changes should be applied immediately,\n or during the next maintenance window for each instance associated with the option group.\n

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "OptionGroupWrapper", "type": "structure", "members": { "OptionGroup": { "shape_name": "OptionGroup", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the option group.\n

\n " }, "OptionGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the option group.\n

\n " }, "EngineName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Engine name that this option group can be applied to.\n

\n " }, "MajorEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the major engine version associated with this option group.\n

\n " }, "Options": { "shape_name": "OptionsList", "type": "list", "members": { "shape_name": "Option", "type": "structure", "members": { "OptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option.\n

\n " }, "OptionDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option.\n

\n " }, "Persistent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicate if this option is persistent.\n

\n " }, "Permanent": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicate if this option is permanent.

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n If required, the port configured for this option to use.\n

\n " }, "OptionSettings": { "shape_name": "OptionSettingConfigurationList", "type": "list", "members": { "shape_name": "OptionSetting", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option that has settings that you can set.\n

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current value of the option setting.\n

\n " }, "DefaultValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The default value of the option setting.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the option setting.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB engine specific parameter type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the option setting.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The allowed values of the option setting.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n A Boolean value that, when true, indicates the option setting can be modified from the default.\n

\n " }, "IsCollection": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the option setting is part of a collection.\n

\n " } }, "documentation": "\n

\n Option settings are the actual settings being applied or configured \n for that option. It is used when you modify an option group or describe \n option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting \n called SQLNET.ENCRYPTION_SERVER that can have several different values.\n

\n ", "xmlname": "OptionSetting" }, "documentation": "\n

\n The option settings for this option. \n

\n " }, "DBSecurityGroupMemberships": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n If the option requires access to a port, then this DB security group allows access to the port. \n

\n " }, "VpcSecurityGroupMemberships": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n If the option requires access to a port, then this VPC security group allows access to the port.\n

\n " } }, "documentation": "\n

\n Option details.\n

\n", "xmlname": "Option" }, "documentation": "\n

\n Indicates what options are available in the option group.\n

\n " }, "AllowsVpcAndNonVpcInstanceMemberships": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether this option group can be applied to both VPC \n and non-VPC instances. The value 'true' indicates the option group \n can be applied to both VPC and non-VPC instances.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n If AllowsVpcAndNonVpcInstanceMemberships is 'false', this field is blank.\n If AllowsVpcAndNonVpcInstanceMemberships is 'true' and this field is blank, \n then this option group can be applied to both VPC and non-VPC instances.\n If this field contains a value, then this option group can only be \n applied to instances that are in the VPC indicated by this field.\n

\n " } }, "wrapper": true, "documentation": "\n

\n

\n " } } }, "errors": [ { "shape_name": "InvalidOptionGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The option group is not in the available state.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " } ], "documentation": "\n

\n Modifies an existing option group. \n

\n \n https://rds.amazonaws.com/\n ?Action=ModifyOptionGroup\n &OptionGroupName=myoptiongroup\n &OptionsToInclude=OEM\n &DBSecurityGroupMemberships=default\n &ApplyImmediately=true\n \n \n \n myoptiongroup\n Test option group\n oracle-se1\n 11.2\n \n \n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n https://rds.amazonaws.com/\n ?Action=ModifyOptionGroup\n &OptionGroupName=myoptiongroup\n &OptionsToRemove=OEM\n &ApplyImmediately=true\n \n \n \n myoptiongroup\n Test option group\n oracle-se1\n 11.2\n \n \n \n \n ed662948-a57b-11df-9e38-7ffab86c801f\n \n \n \n " }, "PromoteReadReplica": { "name": "PromoteReadReplica", "input": { "shape_name": "PromoteReadReplicaMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier.\n This value is stored as a lowercase string.\n

\n

Constraints:

\n \n

Example: mydbinstance

\n ", "required": true }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days to retain automated backups.\n Setting this parameter to a positive number enables backups.\n Setting this parameter to 0 disables automated backups.\n

\n

\n Default: 1\n

\n

Constraints:

\n \n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The daily time range during which automated backups are created\n if automated backups are enabled,\n using the BackupRetentionPeriod parameter.\n

\n

\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region. See the Amazon RDS User Guide for \n the time blocks for each region from which the default \n backup windows are assigned.\n

\n\n

\n Constraints: Must be in the format hh24:mi-hh24:mi. \n Times should be Universal Time Coordinated (UTC). \n Must not conflict with the preferred maintenance window. Must be at least 30 minutes.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " } ], "documentation": "\n

\n Promotes a read replica DB instance to a standalone DB instance.\n

\n \n https://rds.amazonaws.com/\n ?Action=PromoteReadReplica\n &DBInstanceIdentifier=simcoprod01\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2012-08-23T08%3A02%3A09.574Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 2011-05-23T08:00:00Z\n mysql\n \n 50\n \n 1\n false\n general-public-license\n available\n 5.1.50\n \n 3306\n
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
\n \n simcoprod01\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n us-east-1a\n 2011-05-23T06:06:43.110Z\n 10\n db.m1.large\n master\n \n \n \n f61a020f-8512-11e0-90aa-eb648410240d\n \n\n \n " }, "PurchaseReservedDBInstancesOffering": { "name": "PurchaseReservedDBInstancesOffering", "input": { "shape_name": "PurchaseReservedDBInstancesOfferingMessage", "type": "structure", "members": { "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The ID of the Reserved DB instance offering to purchase.\n

\n

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

\n ", "required": true }, "ReservedDBInstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Customer-specified identifier to track this reservation.\n

\n

Example: myreservationID

\n " }, "DBInstanceCount": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of instances to reserve.\n

\n

Default: 1

\n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ReservedDBInstanceWrapper", "type": "structure", "members": { "ReservedDBInstance": { "shape_name": "ReservedDBInstance", "type": "structure", "members": { "ReservedDBInstanceId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier for the reservation.\n

\n " }, "ReservedDBInstancesOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance class for the reserved DB instance.\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time the reservation started.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration of the reservation in seconds.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The fixed price charged for this reserved DB instance.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The hourly price charged for this reserved DB instance.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

\n The currency code for the reserved DB instance.\n

\n " }, "DBInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of reserved DB instances.\n

\n " }, "ProductDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the reserved DB instance.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": " \n

\n The offering type of this reserved DB instance. \n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates if the reservation applies to Multi-AZ deployments.\n

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n The state of the reserved DB instance.\n

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The amount of the recurring charge.\n

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

\n The frequency of the recurring charge.\n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the \n DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.\n

\n ", "xmlname": "RecurringCharge" }, "documentation": " \n

\n The recurring price charged to run this reserved DB instance. \n

\n " } }, "wrapper": true, "documentation": "\n

\n This data type is used as a response element in the \n DescribeReservedDBInstances and \n PurchaseReservedDBInstancesOffering actions.\n

\n " } } }, "errors": [ { "shape_name": "ReservedDBInstancesOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified offering does not exist.\n

\n " }, { "shape_name": "ReservedDBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a reservation with the given identifier.\n

\n " }, { "shape_name": "ReservedDBInstanceQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would exceed the user's DB Instance quota.\n

\n " } ], "documentation": "\n

\n Purchases a reserved DB instance offering.\n

\n \n https://rds.amazonaws.com/\n ?Action=PurchaseReservedDBInstancesOffering\n &ReservedDBInstanceId=myreservationID\n &ReservedDBInstancesOfferingId=438012d3-4052-4cc7-b2e3-8d3372e0e706\n &DBInstanceCount=1\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-10T18%3A31%3A36.118Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n Medium Utilization\n USD\n \n mysql\n 438012d3-4052-4cc7-b2e3-8d3372e0e706\n true\n payment-pending\n myreservationID\n 10\n 2011-12-18T23:24:56.577Z\n 31536000\n 123.0\n 0.123\n db.m1.small\n \n \n \n 7f099901-29cf-11e1-bd06-6fe008f046c3\n \n\n\n \n " }, "RebootDBInstance": { "name": "RebootDBInstance", "input": { "shape_name": "RebootDBInstanceMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB instance identifier.\n This parameter is stored as a lowercase string.\n

\n

Constraints:

\n \n ", "required": true }, "ForceFailover": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n When true, the reboot will be conducted through a MultiAZ failover.\n

\n

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " } ], "documentation": "\n

\n Rebooting a DB instance restarts the database engine service. A reboot \n also applies to the DB instance any modifications to the associated DB \n parameter group that were pending. Rebooting a DB instance results in a \n momentary outage of the instance, during which the DB instance status is \n set to rebooting. If the RDS instance is configured for MultiAZ, it is \n possible that the reboot will be conducted through a failover. An Amazon \n RDS event is created when the reboot is completed.\n

\n

\n If your DB instance is deployed in multiple Availability Zones, you \n can force a failover from one AZ to the other during the reboot. You \n might force a failover to test the availability of your DB instance \n deployment or to restore operations to the original AZ after a failover occurs.\n

\n

\n The time required to reboot is a function of the specific database engine's \n crash recovery process. To improve the reboot time, we recommend that you \n reduce database activities as much as possible during the reboot process \n to reduce rollback activity for in-transit transactions.\n

\n \n https://rds.amazonaws.com/\n ?Action=RebootDBInstance\n &DBInstanceIdentifier=simcoprod01\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2011-05-23T06%3A10%3A31.216Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n 2011-05-23T06:07:38.831Z\n mysql\n \n 1\n false\n general-public-license\n rebooting\n 5.1.50\n \n 3306\n
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
\n \n simcoprod01\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n us-east-1a\n 2011-05-23T06:06:43.110Z\n 10\n db.m1.large\n master\n \n \n \n 5d5df758-8503-11e0-90aa-eb648410240d\n \n\n \n " }, "RemoveSourceIdentifierFromSubscription": { "name": "RemoveSourceIdentifierFromSubscription", "input": { "shape_name": "RemoveSourceIdentifierFromSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the RDS event notification subscription you want to remove a source identifier from.

\n ", "required": true }, "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source identifier to be removed from the subscription, such as the DB instance identifier \n for a DB instance or the name of a security group.\n

\n\n ", "required": true } }, "documentation": " \n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the RDS event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The RDS event notification subscription Id.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The topic ARN of the RDS event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the RDS event notification subscription.

\n

Constraints:

\n

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

\n

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \n \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

\n " }, "SubscriptionCreationTime": { "shape_name": "String", "type": "string", "documentation": "\n

The time the RDS event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type for the RDS event notification subscription.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of source Ids for the RDS event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

A list of event categories for the RDS event notification subscription.

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

\n " } } }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The subscription name does not exist.

\n " }, { "shape_name": "SourceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The requested source could not be found.

\n " } ], "documentation": "\n

Removes a source identifier from an existing RDS event notification subscription.

\n \n https://rds.us-east-1.amazonaws.com/\n ?Action=RemoveSourceIdentifierFromSubscription\n &SubscriptionName=EventSubscription01\n &SourceIdentifier=dbinstance01\n &Version=2013-01-10\n &SignatureVersion=4\n &SignatureMethod=HmacSHA256\n &Timestamp=20130128T012415Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n\n \n \n true\n 012345678901\n db-instance\n modifying\n 2013-01-28 00:29:23.736\n \n creation\n deletion\n \n EventSubscription01\n arn:aws:sns:us-east-1:012345678901:EventSubscription01\n \n \n \n 6f0b82bf-68e9-11e2-b97b-43c6362ec60d\n \n\n \n \n \n " }, "RemoveTagsFromResource": { "name": "RemoveTagsFromResource", "input": { "shape_name": "RemoveTagsFromResourceMessage", "type": "structure", "members": { "ResourceName": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about \n creating an ARN, \n see \n Constructing an RDS Amazon Resource Name (ARN).

\n ", "required": true }, "TagKeys": { "shape_name": "KeyList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The tag key (name) of the tag to be removed.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " } ], "documentation": "\n

Removes metadata tags from an Amazon RDS resource.

\n

For an overview on tagging an Amazon RDS resource, \n see Tagging Amazon RDS Resources.

\n " }, "ResetDBParameterGroup": { "name": "ResetDBParameterGroup", "input": { "shape_name": "ResetDBParameterGroupMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n

Constraints:

\n \n ", "required": true }, "ResetAllParameters": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether (true) or not (false) to reset all parameters\n in the DB parameter group to default values.\n

\n

Default: true

\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides a description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the source of the parameter value.\n

\n " }, "ApplyType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the engine specific parameters type.\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid data type for the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates whether (true) or not (false) the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " }, "ApplyMethod": { "shape_name": "ApplyMethod", "type": "string", "enum": [ "immediate", "pending-reboot" ], "documentation": "\n

\n Indicates when to apply parameter updates.\n

\n " } }, "documentation": "\n

\n This data type is used as a request parameter in the\n ModifyDBParameterGroup and ResetDBParameterGroup actions.\n

\n

This data type is used as a response element in the \n DescribeEngineDefaultParameters and DescribeDBParameters actions.

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n An array of parameter names, values, and the apply method\n for the parameter update. At least one parameter name,\n value, and apply method must be supplied; subsequent arguments are optional.\n A maximum of 20 parameters may be modified in a single request.\n

\n

MySQL

\n

Valid Values (for Apply method): immediate | pending-reboot

\n

You can use the immediate value with dynamic parameters only. You can use \n the pending-reboot value for both dynamic and static parameters, and changes \n are applied when DB instance reboots.

\n

Oracle

\n

Valid Values (for Apply method): pending-reboot

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBParameterGroupNameMessage", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB parameter group.\n

\n " } }, "documentation": "\n

\n Contains the result of a successful invocation of the \n ModifyDBParameterGroup or ResetDBParameterGroup action.\n

\n " }, "errors": [ { "shape_name": "InvalidDBParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The DB parameter group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "DBParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBParameterGroupName does not refer to an\n existing DB parameter group.\n

\n " } ], "documentation": "\n

\n Modifies the parameters of a DB parameter group to the engine/system default value. To\n reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the\n entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters.\n When resetting the entire group, dynamic parameters are updated immediately and static parameters\n are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.\n

\n \n https://rds.amazonaws.com/\n ?Action=ResetDBParameterGroup\n &DBParameterGroupName=mydbparametergroup\n &Parameters.member.1.ParameterName=max_user_connections\n &Parameters.member.1.ApplyMethod=pending-reboot\n &Parameters.member.2.ParameterName=max_allowed_packet\n &Parameters.member.2.ApplyMethod=immediate\n &ResetAllParameters=false\n &Version=2013-05-15\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n mydbparametergroup\n \n \n 071e758f-bf57-11de-9f9f-53d6aee22de9\n \n\n \n " }, "RestoreDBInstanceFromDBSnapshot": { "name": "RestoreDBInstanceFromDBSnapshot", "input": { "shape_name": "RestoreDBInstanceFromDBSnapshotMessage", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the DB snapshot to restore from.\n

\n

Constraints:

\n \n ", "required": true }, "DBSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Name of the DB instance to create from the DB snapshot.\n This parameter isn't case sensitive.\n

\n

Constraints:

\n \n

Example: my-snapshot-id

\n ", "required": true }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The compute and memory capacity of the Amazon RDS DB instance.\n

\n

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number on which the database accepts connections.\n

\n

Default: The same port as the original DB instance

\n

Constraints: Value must be 1150-65535

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The EC2 Availability Zone that the database instance will be created in.\n

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

\n

Example: us-east-1a

\n " }, "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB subnet group name to use for the new instance.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that minor version upgrades will be applied\n automatically to the DB instance during the maintenance window.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n

\n Default: Same as source.\n

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database name for the restored DB instance.\n

\n \n

This parameter doesn't apply to the MySQL engine.

\n \n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database engine to use for the new instance.\n

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Example: oracle-ee

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.\n If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter \n is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional \n time, though your DB instance will be available for connections before the conversion starts.\n

\n

Constraints: Must be an integer greater than 1000.

\n \n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the option group to be used for the restored DB instance.

\n

\n \n Permanent options, such as the TDE option for Oracle Advanced Security TDE, \n cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance\n

\n \n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "DBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a DB instance with the given identifier.\n

\n " }, { "shape_name": "DBSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSnapshotIdentifier does not refer to an existing DB snapshot.\n

\n " }, { "shape_name": "InstanceQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB instances.\n

\n " }, { "shape_name": "InsufficientDBInstanceCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified DB instance class is not available in the specified Availability Zone.\n

\n " }, { "shape_name": "InvalidDBSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB snapshot does not allow deletion.\n

\n " }, { "shape_name": "StorageQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the\n allowed amount of storage available across all DB instances.\n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n DB subnet group does not cover all Availability Zones after it is created because users' change.\n

\n " }, { "shape_name": "InvalidRestoreFault", "type": "structure", "members": {}, "documentation": "\n

\n Cannot restore from vpc backup to non-vpc DB instance.\n

\n " }, { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " }, { "shape_name": "ProvisionedIopsNotAvailableInAZFault", "type": "structure", "members": {}, "documentation": "\n

\n Provisioned IOPS not available in the specified Availability Zone.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " } ], "documentation": "\n

\n Creates a new DB instance from a DB snapshot. The target database is created\n from the source database restore point with the same configuration as the original source database,\n except that the new RDS instance is created with the default security group.\n

\n \n https://rds.amazon.com/\n ?Action=RestoreDBInstanceFromDBSnapshot\n &DBSnapshotIdentifier=mydbsnapshot\n &DBInstanceIdentifier=myrestoreddbinstance\n &Version=2013-05-15\n &Timestamp=2011-05-23T06%3A47%3A11.071Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql\n \n 1\n false\n general-public-license\n creating\n 5.1.50\n myrestoreddbinstance\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n 10\n db.m1.large\n master\n \n \n \n 7ca622e8-8508-11e0-bd9b-a7b1ece36d51\n \n\n \n " }, "RestoreDBInstanceToPointInTime": { "name": "RestoreDBInstanceToPointInTime", "input": { "shape_name": "RestoreDBInstanceToPointInTimeMessage", "type": "structure", "members": { "SourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the source DB instance from which to restore.\n

\n

Constraints:

\n \n ", "required": true }, "TargetDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the new database instance to be created.\n

\n

Constraints:

\n \n ", "required": true }, "RestoreTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time to restore from.\n

\n

Valid Values: Value must be a UTC time

\n

Constraints:

\n \n

Example: 2009-09-07T23:45:00Z

\n " }, "UseLatestRestorableTime": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies whether (true) or not (false) the\n DB instance is restored from the latest backup time.\n

\n

Default: false

\n

Constraints: Cannot be specified if RestoreTime parameter is provided.

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n The compute and memory capacity of the Amazon RDS DB instance.\n

\n

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

\n

Default: The same DBInstanceClass as the original DB instance.

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number on which the database accepts connections.\n

\n

Constraints: Value must be 1150-65535

\n

Default: The same port as the original DB instance.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The EC2 Availability Zone that the database instance will be created in.\n

\n

Default: A random, system-chosen Availability Zone.

\n

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

\n

Example: us-east-1a

\n " }, "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DB subnet group name to use for the new instance.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for the restored DB instance.\n

\n

\n Default: Same as source.\n

\n

\n Valid values: license-included | bring-your-own-license | general-public-license\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database name for the restored DB instance.\n

\n \n

This parameter is not used for the MySQL engine.

\n \n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n The database engine to use for the new instance.\n

\n

Default: The same as source

\n

Constraint: Must be compatible with the engine of the source

\n

Example: oracle-ee

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the\n DB instance. \n

\n

Constraints: Must be an integer greater than 1000.

\n " }, "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the option group to be used for the restored DB instance.

\n

\n \n Permanent options, such as the TDE option for Oracle Advanced Security TDE, \n cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance\n

\n \n " }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\n

A key is the required name of the tag. The string value can be from \n 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\n

A value is the optional value of the tag. The string value can be from \n 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". \n The string may only contain only the set of Unicode letters, digits, \n white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

\n " } }, "documentation": "\n

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

\n ", "xmlname": "Tag" }, "documentation": "\n

A list of tags.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBInstanceWrapper", "type": "structure", "members": { "DBInstance": { "shape_name": "DBInstance", "type": "structure", "members": { "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains a user-supplied database identifier.\n This is the unique key that identifies a DB instance.\n

\n " }, "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the name of the compute and memory\n capacity class of the DB instance.\n

\n " }, "Engine": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the name of the database engine to be used for this DB instance.\n

\n " }, "DBInstanceStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the current state of this database.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the master username for the DB instance.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The meaning of this parameter differs according to the database engine you use. For example, this value returns only MySQL \n information when returning values from CreateDBInstanceReadReplica since read replicas are only supported for MySQL.

\n

MySQL

\n

\n Contains the name of the initial database of this instance that was\n provided at create time, if one was specified when the\n DB instance was created. This same name is returned for\n the life of the DB instance.\n

\n

Type: String

\n

Oracle

\n

\n Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to \n an Oracle DB instance. \n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the DNS address of the DB instance.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n Specifies the connection endpoint.\n

\n " }, "AllocatedStorage": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the allocated storage size specified in gigabytes.\n

\n " }, "InstanceCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Provides the date and time the DB instance was created.\n

\n " }, "PreferredBackupWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the daily time range during which automated backups are\n created if automated backups are enabled, as determined\n by the BackupRetentionPeriod.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n Specifies the number of days for which automatic DB snapshots are retained.\n

\n " }, "DBSecurityGroups": { "shape_name": "DBSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "DBSecurityGroupMembership", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB security group.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "DBSecurityGroup" }, "documentation": "\n

\n Provides List of DB security group elements containing only\n DBSecurityGroup.Name and DBSecurityGroup.Status subelements.\n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the VPC security group.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the VPC security group.\n

\n " } }, "documentation": "\n

This data type is used as a response element for queries on VPC security group membership.

\n ", "xmlname": "VpcSecurityGroupMembership" }, "documentation": "\n

\n Provides List of VPC security group elements \n that the DB instance belongs to. \n

\n " }, "DBParameterGroups": { "shape_name": "DBParameterGroupStatusList", "type": "list", "members": { "shape_name": "DBParameterGroupStatus", "type": "structure", "members": { "DBParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DP parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n The status of the DB parameter group.\n

\n

This data type is used as a response element in the following actions:

\n \n ", "xmlname": "DBParameterGroup" }, "documentation": "\n

\n Provides the list of DB parameter groups applied to this DB instance.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the Availability Zone the DB instance is located in.\n

\n " }, "DBSubnetGroup": { "shape_name": "DBSubnetGroup", "type": "structure", "members": { "DBSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB subnet group.\n

\n " }, "DBSubnetGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the DB subnet group.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " }, "ProvisionedIopsCapable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n True indicates the availability zone is capable of provisioned IOPs.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains Availability Zone information. \n

\n

\n This data type is used as an element in the following data type:\n

\n \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the subnet.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSubnetGroups action.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n Contains a list of Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "DBInstanceClass": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceClass for the DB instance\n that will be applied or is in progress.\n

\n " }, "AllocatedStorage": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Contains the new AllocatedStorage size for the DB instance\n that will be applied or is in progress.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the pending or in-progress change of the master credentials for the DB instance.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending port for the DB instance.\n

\n " }, "BackupRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the pending number of days for which automated backups are retained.\n

\n " }, "MultiAZ": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version. \n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the new Provisioned IOPS value for the DB instance\n that will be applied or is being applied.\n

\n " }, "DBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the new DBInstanceIdentifier for the DB instance\n that will be applied or is in progress.\n

\n " } }, "documentation": "\n

\n Specifies that changes to the DB instance are pending.\n This element is only included when changes are pending.\n Specific changes are identified by subelements.\n

\n " }, "LatestRestorableTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest time to which a database\n can be restored with point-in-time restore.\n

\n " }, "MultiAZ": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Specifies if the DB instance is a Multi-AZ deployment.\n

\n " }, "EngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n Indicates the database engine version.\n

\n " }, "AutoMinorVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Indicates that minor version patches are applied automatically.\n

\n " }, "ReadReplicaSourceDBInstanceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n Contains the identifier of the source DB instance if this DB instance is a read replica.\n

\n " }, "ReadReplicaDBInstanceIdentifiers": { "shape_name": "ReadReplicaDBInstanceIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReadReplicaDBInstanceIdentifier" }, "documentation": "\n

\n Contains one or more identifiers of the read replicas associated with this DB instance.\n

\n " }, "LicenseModel": { "shape_name": "String", "type": "string", "documentation": "\n

\n License model information for this DB instance.\n

\n " }, "Iops": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n Specifies the Provisioned IOPS (I/O operations per second) value.\n

\n " }, "OptionGroupMemberships": { "shape_name": "OptionGroupMembershipList", "type": "list", "members": { "shape_name": "OptionGroupMembership", "type": "structure", "members": { "OptionGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the option group that the instance belongs to.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).\n

\n " } }, "documentation": " \n

\n Provides information on the option groups the DB instance is a member of.\n

\n ", "xmlname": "OptionGroupMembership" }, "documentation": "\n

\n Provides the list of option group memberships for this DB instance.\n

\n " }, "CharacterSetName": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the character set that this instance is associated with. \n

\n " }, "SecondaryAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n If present, specifies the name of the secondary Availability Zone \n for a DB instance with multi-AZ support.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n

\n Specifies the accessibility options for the DB instance. \n A value of true specifies an Internet-facing instance with a publicly resolvable DNS name,\n which resolves to a public IP address.\n A value of false specifies an internal instance with a DNS name that resolves to a private IP address. \n

\n

\n Default: The default behavior varies depending on whether a VPC has been requested or not.\n The following list shows the default behavior in each case.\n

\n \n

\n If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. \n If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. \n

\n " }, "StatusInfos": { "shape_name": "DBInstanceStatusInfoList", "type": "list", "members": { "shape_name": "DBInstanceStatusInfo", "type": "structure", "members": { "StatusType": { "shape_name": "String", "type": "string", "documentation": "\n

\n This value is currently \"read replication.\"\n

\n " }, "Normal": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n 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.\n

\n " } }, "documentation": "\n

Provides a list of status information for a DB instance.

\n ", "xmlname": "DBInstanceStatusInfo" }, "documentation": "\n

\n The status of a read replica. If the instance is not a read replica, this will be blank.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBInstances action.

\n " } } }, "errors": [ { "shape_name": "DBInstanceAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a DB instance with the given identifier.\n

\n " }, { "shape_name": "DBInstanceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBInstanceIdentifier does not refer to an existing DB instance.\n

\n " }, { "shape_name": "InstanceQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the allowed number of DB instances.\n

\n " }, { "shape_name": "InsufficientDBInstanceCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified DB instance class is not available in the specified Availability Zone.\n

\n " }, { "shape_name": "InvalidDBInstanceStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified DB instance is not in the available state.\n

\n " }, { "shape_name": "PointInTimeRestoreNotEnabledFault", "type": "structure", "members": {}, "documentation": "\n

\n SourceDBInstanceIdentifier\n refers to a DB instance with\n BackupRetentionPeriod equal to 0.\n

\n " }, { "shape_name": "StorageQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would result in user exceeding the\n allowed amount of storage available across all DB instances.\n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n DB subnet group does not cover all Availability Zones after it is created because users' change.\n

\n " }, { "shape_name": "InvalidRestoreFault", "type": "structure", "members": {}, "documentation": "\n

\n Cannot restore from vpc backup to non-vpc DB instance.\n

\n " }, { "shape_name": "DBSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSubnetGroupName does not refer to an existing DB subnet group.\n

\n " }, { "shape_name": "DBSubnetGroupDoesNotCoverEnoughAZs", "type": "structure", "members": {}, "documentation": "\n

\n Subnets in the DB subnet group should cover at least 2 Availability Zones unless there is only 1 availablility zone.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. \n

\n " }, { "shape_name": "ProvisionedIopsNotAvailableInAZFault", "type": "structure", "members": {}, "documentation": "\n

\n Provisioned IOPS not available in the specified Availability Zone.\n

\n " }, { "shape_name": "OptionGroupNotFoundFault", "type": "structure", "members": {}, "documentation": " \n

\n The specified option group could not be found. \n

\n " } ], "documentation": "\n

\n Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in\n time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created\n from the source database with the same configuration as the original database except that the DB instance\n is created with the default DB security group.\n

\n \n https://rds.amazon.com/\n ?Action=RestoreDBInstanceToPointInTime\n &TargetDBInstanceIdentifier=restored-db\n &SourceDBInstanceIdentifier=simcoprod01\n &UseLatestRestorableTime=true\n &Version=2013-05-15\n &Timestamp=2011-05-23T07%3A06%3A02.313Z\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n mysql\n \n 1\n false\n general-public-license\n creating\n 5.1.50\n restored-db\n \n \n in-sync\n default.mysql5.1\n \n \n \n \n active\n default\n \n \n 00:00-00:30\n true\n sat:07:30-sat:08:00\n 10\n db.m1.large\n master\n \n \n \n 1ef546bc-850b-11e0-90aa-eb648410240d\n \n\n \n " }, "RevokeDBSecurityGroupIngress": { "name": "RevokeDBSecurityGroupIngress", "input": { "shape_name": "RevokeDBSecurityGroupIngressMessage", "type": "structure", "members": { "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the DB security group to revoke ingress from.\n

\n ", "required": true }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range to revoke access from. \n Must be a valid CIDR range. If CIDRIP is specified, \n EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId\n cannot be provided.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The id of the EC2 security group to revoke access from.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS Account Number of the owner of the EC2 security group\n specified in the EC2SecurityGroupName parameter.\n The AWS Access Key ID is not an acceptable value.\n For VPC DB security groups, EC2SecurityGroupId must be provided.\n Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DBSecurityGroupWrapper", "type": "structure", "members": { "DBSecurityGroup": { "shape_name": "DBSecurityGroup", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the AWS ID of the owner of a specific DB security group.\n

\n " }, "DBSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the DB security group.\n

\n " }, "DBSecurityGroupDescription": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the description of the DB security group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the VpcId of the DB security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Provides the status of the EC2 security group. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the name of the EC2 security group.\n

\n " }, "EC2SecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the id of the EC2 security group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the following actions:\n

\n \n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n Contains a list of EC2SecurityGroup elements.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the status of the IP range. Status can be \"authorizing\", \n \"authorized\", \"revoking\", and \"revoked\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n Specifies the IP range.\n

\n " } }, "documentation": "\n

\n This data type is used as a response element in the DescribeDBSecurityGroups action.\n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n Contains a list of IPRange elements.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Contains the result of a successful invocation of the following actions:\n

\n \n

This data type is used as a response element in the DescribeDBSecurityGroups action.

\n \n " } } }, "errors": [ { "shape_name": "DBSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n DBSecurityGroupName does not refer to an existing DB security group.\n

\n " }, { "shape_name": "AuthorizationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified CIDRIP or EC2 security group is not authorized\n for the specified DB security group.\n

\n " }, { "shape_name": "InvalidDBSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the DB security group does not allow deletion.\n

\n " } ], "documentation": "\n

\n Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security\n Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId\n and either EC2SecurityGroupName or EC2SecurityGroupId).\n

\n \n https://rds.amazonaws.com/\n ?Action=RevokeDBSecurityGroupIngress\n &DBSecurityGroupName=mydbsecuritygroup\n &CIDRIP=192.168.1.1%2F24\n &Version=2013-05-15\n &SignatureVersion=2&SignatureMethod=HmacSHA256\n &Timestamp=2011-02-15T22%3A32%3A12.515Z\n &AWSAccessKeyId=\n &Signature=\n \n \n \n \n My new DBSecurityGroup\n \n \n 192.168.1.1/24\n revoking\n \n \n 621567473609\n mydbsecuritygroup\n vpc-1ab2c3d4\n \n \n \n beecb8ac-bf5a-11de-9f9f-53d6aee22de9\n \n\n \n " } }, "metadata": { "regions": { "us-east-1": "https://rds.amazonaws.com/", "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://rds.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "pagination": { "DescribeDBEngineVersions": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBEngineVersions", "py_input_token": "marker" }, "DescribeDBInstances": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBInstances", "py_input_token": "marker" }, "DescribeDBParameterGroups": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBParameterGroups", "py_input_token": "marker" }, "DescribeDBParameters": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "Parameters", "py_input_token": "marker" }, "DescribeDBSecurityGroups": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSecurityGroups", "py_input_token": "marker" }, "DescribeDBSnapshots": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSnapshots", "py_input_token": "marker" }, "DescribeDBSubnetGroups": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "DBSubnetGroups", "py_input_token": "marker" }, "DescribeEngineDefaultParameters": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "EngineDefaults", "py_input_token": "marker" }, "DescribeEventSubscriptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EventSubscriptionsList", "py_input_token": "marker" }, "DescribeEvents": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "Events", "py_input_token": "marker" }, "DescribeOptionGroupOptions": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OptionGroupOptions", "py_input_token": "marker" }, "DescribeOptionGroups": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OptionGroupsList", "py_input_token": "marker" }, "DescribeOrderableDBInstanceOptions": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "OrderableDBInstanceOptions", "py_input_token": "marker" }, "DescribeReservedDBInstances": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "ReservedDBInstances", "py_input_token": "marker" }, "DescribeReservedDBInstancesOfferings": { "limit_key": "MaxRecords", "input_token": "Marker", "output_token": "Marker", "result_key": "ReservedDBInstancesOfferings", "py_input_token": "marker" } }, "waiters": { "DBInstanceAvailable": { "success": { "path": "DBInstances[].DBInstanceStatus", "type": "output", "value": [ "available" ] }, "interval": 30, "failure": { "path": "DBInstances[].DBInstanceStatus", "type": "output", "value": [ "deleted", "deleting", "failed", "incompatible-restore", "incompatible-parameters", "incompatible-parameters", "incompatible-restore" ] }, "operation": "DescribeDBInstances", "max_attempts": 60 }, "DBInstanceDeleted": { "success": { "path": "DBInstances[].DBInstanceStatus", "type": "output", "value": [ "deleted" ] }, "interval": 30, "failure": { "path": "DBInstances[].DBInstanceStatus", "type": "output", "value": [ "creating", "modifying", "rebooting", "resetting-master-credentials" ] }, "operation": "DescribeDBInstances", "max_attempts": 60 } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/redshift.json0000644000175000017500000261640612254746566020772 0ustar takakitakaki{ "api_version": "2012-12-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Redshift", "endpoint_prefix": "redshift", "xmlnamespace": "http://redshift.amazonaws.com/doc/2012-12-01/", "documentation": "\n \tAmazon Redshift\n Overview\n

\n This is an interface reference for Amazon Redshift. It contains documentation for one of the\n programming or command line interfaces you can use to manage Amazon Redshift clusters. Note\n that Amazon Redshift is asynchronous, which means that some interfaces may require techniques,\n such as polling or asynchronous callback handlers, to determine when a command has been\n applied. In this reference, the parameter descriptions indicate whether a change is\n applied immediately, on the next instance reboot, or during the next maintenance\n window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces\n .

\n

\n Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: \n provisioning capacity, monitoring and backing up the cluster, and applying patches and \n upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new \n insights for your business and customers.\n

\n

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the\n The Amazon Redshift Getting Started Guide

\n\n

If you are a database developer, the Amazon Redshift Database Developer Guide\n explains how to design, build, query, and maintain the databases that make up your\n data warehouse.

\n \n ", "operations": { "AuthorizeClusterSecurityGroupIngress": { "name": "AuthorizeClusterSecurityGroupIngress", "input": { "shape_name": "AuthorizeClusterSecurityGroupIngressMessage", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the security group to which the ingress rule is added.\n

\n ", "required": true }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range to be added the Amazon Redshift security group.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The EC2 security group to be added the Amazon Redshift security group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS account number of the owner of the security group\n specified by the EC2SecurityGroupName parameter.\n The AWS Access Key ID is not an acceptable value.\n

\n

\n Example: 111122223333\n

\n " } }, "documentation": "\n

\n ???\n

\n " }, "output": { "shape_name": "ClusterSecurityGroupWrapper", "type": "structure", "members": { "ClusterSecurityGroup": { "shape_name": "ClusterSecurityGroup", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group to which the operation was applied.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the EC2 security group.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 Security Group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

Describes an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n A list of EC2 security groups that are permitted to access clusters associated with \n this cluster security group.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the IP range, for example, \"authorized\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range in Classless Inter-Domain Routing (CIDR) notation.\n

\n " } }, "documentation": "\n

\n Describes an IP range used in a security group. \n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n A list of IP ranges (CIDR blocks) that are permitted to access \n clusters associated with this cluster security group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a security group.

\n " } } }, "errors": [ { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " }, { "shape_name": "InvalidClusterSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster security group is not \"available\".\n

\n " }, { "shape_name": "AuthorizationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.\n

\n " }, { "shape_name": "AuthorizationQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The authorization quota for the cluster security group has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

\n Adds an inbound (ingress) rule to an Amazon Redshift security group. \n Depending on whether the application accessing your cluster is running \n on the Internet or an EC2 instance, you can \n authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range\n or an EC2 security group. \n You can add as many as 20 ingress rules to an Amazon Redshift security group. \n

\n \n The EC2 security group must be defined in the AWS region where the cluster resides.\n \n

For an overview of CIDR blocks, see the Wikipedia article on \n Classless Inter-Domain Routing.\n

\n

\n You must also associate the security group with a cluster so that clients \n running on these IP addresses or the EC2 instance are authorized to connect to the cluster.\n For information about managing security groups, go to\n Working with Security Groups in the \n Amazon Redshift Management Guide.

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=AuthorizeClusterSecurityGroupIngress\n &CIDRIP=192.168.40.3/32\n &ClusterSecurityGroupName=securitygroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T020649Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n \n 192.168.40.3/32\n authorized\n \n \n my security group\n securitygroup1\n \n \n \n 8c7cd4c8-6501-11e2-a8da-655adc216806\n \n\n \n " }, "AuthorizeSnapshotAccess": { "name": "AuthorizeSnapshotAccess", "input": { "shape_name": "AuthorizeSnapshotAccessMessage", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the snapshot the account is authorized to restore.\n

\n ", "required": true }, "SnapshotClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n " }, "AccountWithRestoreAccess": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the AWS customer account authorized to restore the specified snapshot.\n

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n " } } }, "errors": [ { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " }, { "shape_name": "AuthorizationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.\n

\n " }, { "shape_name": "AuthorizationQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The authorization quota for the cluster security group has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

\n Authorizes the specified AWS customer account to restore the specified snapshot.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n " }, "CopyClusterSnapshot": { "name": "CopyClusterSnapshot", "input": { "shape_name": "CopyClusterSnapshotMessage", "type": "structure", "members": { "SourceSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the source snapshot.\n

\n

Constraints:

\n \n ", "required": true }, "SourceSnapshotClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n

Constraints:

\n \n " }, "TargetSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier given to the new manual snapshot.\n

\n

Constraints:

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n " } } }, "errors": [ { "shape_name": "ClusterSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " }, { "shape_name": "InvalidClusterSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster snapshot is not \"available\", or other accounts are authorized to access the snapshot.\n

\n " }, { "shape_name": "ClusterSnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

\n " } ], "documentation": "\n

\n Copies the specified automated cluster snapshot to a new manual cluster snapshot. \n The source must be an automated snapshot and it must be in the available state.\n

\n

\n When you delete a cluster, Amazon Redshift deletes any automated snapshots \n of the cluster. Also, when the retention period of the snapshot expires,\n Amazon Redshift automatically deletes it. If you want to keep an \n automated snapshot for a longer period, you can make a manual\n copy of the snapshot. Manual snapshots are retained until you delete them. \n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CopyClusterSnapshot\n &SourceSnapshotIdentifier=cm:examplecluster-2013-01-22-19-27-58\n &TargetSnapshotIdentifier=my-snapshot-456\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T014618Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 5439\n my-snapshot-456\n available\n manual\n 1.0\n 2013-01-22T19:27:58.931Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw.hs1.xlarge\n examplecluster\n adminuser\n \n \n \n aebb56f5-64fe-11e2-88c5-53eb05787dfb\n \n\n \n " }, "CreateCluster": { "name": "CreateCluster", "input": { "shape_name": "CreateClusterMessage", "type": "structure", "members": { "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the first database to be created when the cluster\n is created.

\n

To create additional databases after the cluster is created, connect to the\n cluster with a SQL client and use SQL commands to create a database.\n For more information, go to\n Create a Database in the Amazon Redshift Database Developer Guide. \n

\n

Default: dev

\n

Constraints:

\n \n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n A unique identifier for the cluster. You use this identifier to refer to the \n cluster for any subsequent cluster operations such as deleting or modifying. \n The identifier also appears in the Amazon Redshift console.\n

\n \n

Constraints:

\n\n\n

Example: myexamplecluster

\n ", "required": true }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of the cluster. When cluster type is specified as\n

\n

\n

\n Valid Values: multi-node | single-node\n

\n

Default: multi-node

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type to be provisioned for the cluster. \n For information about node types, go to \n Working with Clusters in the Amazon Redshift Management Guide.

\n

\n Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge. \n

\n ", "required": true }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The user name associated with the master user account for the cluster that is being created.\n

\n

Constraints:

\n \n ", "required": true }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The password associated with the master user account for the cluster that is being created.\n

\n

\n Constraints:\n

\n \n ", "required": true }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterSecurityGroupName" }, "documentation": "\n

\n A list of security groups to be associated\n with this cluster.\n

\n

\n Default: The default cluster security group for Amazon Redshift. \n

\n " }, "VpcSecurityGroupIds": { "shape_name": "VpcSecurityGroupIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcSecurityGroupId" }, "documentation": "\n

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

\n

Default: The default VPC security group is associated with the cluster.

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a cluster subnet group to be associated with this cluster.\n

\n

\n If this parameter is not provided the resulting cluster will be deployed\n outside virtual private cloud (VPC).\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. \n For example, if you have several \n EC2 instances running in a specific Availability Zone, then you might \n want the cluster to be provisioned in the same zone in order to decrease network latency. \n

\n

\n Default: A random, system-chosen Availability Zone in the region that is specified\n by the endpoint.\n

\n

\n Example: us-east-1d\n

\n

\n Constraint: The specified Availability Zone must be in the same region as the current endpoint.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which automated cluster maintenance can occur.\n

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n Default: A 30-minute window selected at random from an\n 8-hour block of time per region, occurring on a random day of the\n week. The following list shows the time blocks for each region \n from which the default maintenance windows are assigned.\n

\n \n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Minimum 30-minute window.

\n " }, "ClusterParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter group to be associated\n with this cluster. \n

\n

Default: The default Amazon Redshift \n cluster parameter group. For information about the default parameter group,\n go to Working with Amazon Redshift Parameter Groups

\n

\n Constraints:\n

\n \n \n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days that automated snapshots are retained.\n If the value is 0, automated snapshots are disabled. Even if\n automated snapshots are disabled, you can still create\n manual snapshots when you want with CreateClusterSnapshot.\n

\n

\n Default: 1\n

\n

Constraints: Must be a value from 0 to 35.

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number on which the cluster accepts incoming connections.\n

\n

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the\n connection string requires the port on which the cluster will listen for incoming connections.

\n

\n Default: 5439\n

\n

\n Valid Values: 1150-65535\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version of the Amazon Redshift engine software that you want to deploy on the cluster.\n

\n

\n The version selected \n runs on all the nodes in the cluster.\n

\n

Constraints: Only version 1.0 is currently available.

\n

Example: 1.0

\n " }, "AllowVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

If true, upgrades can be applied during the maintenance window to the \n Amazon Redshift engine that is running on the cluster.

\n

\n When a new version of the Amazon Redshift engine is released, \n you can request that the service automatically apply upgrades during the maintenance\n window to the Amazon Redshift engine \n that is running on your cluster. \n

\n

Default: true

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster. \n This parameter is required when the ClusterType parameter is \n specified as multi-node.\n

\n

For information about determining how many nodes you need, go to \n Working with Clusters in the Amazon Redshift Management Guide.

\n \n

If you don't specify this parameter, you get a single-node cluster. When \n requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

\n

Default: 1

\n

Constraints: Value must be at least 1 and no more than 100.

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

If true, the data in cluster is encrypted at rest.

\n

Default: false

\n " }, "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The Elastic IP (EIP) address for the cluster.

\n

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Management Guide.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "ClusterAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The account already has a cluster with the given identifier.\n

\n " }, { "shape_name": "InsufficientClusterCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

\n " }, { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " }, { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " }, { "shape_name": "ClusterQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would exceed the allowed number of cluster instances for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "NumberOfNodesQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

\n " }, { "shape_name": "NumberOfNodesPerClusterLimitExceededFault", "type": "structure", "members": {}, "documentation": "\n

The operation would exceed the number of nodes allowed for a cluster.

\n " }, { "shape_name": "ClusterSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group does not cover all Availability Zones.\n

\n " }, { "shape_name": "InvalidClusterSubnetGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " }, { "shape_name": "HsmClientCertificateNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM client certificate with the specified identifier.

\n " }, { "shape_name": "HsmConfigurationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM configuration with the specified identifier.

\n " }, { "shape_name": "InvalidElasticIpFault", "type": "structure", "members": {}, "documentation": "\n

The Elastic IP (EIP) is invalid or cannot be found.

\n " } ], "documentation": "\n

\n Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If \n you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift \n creates a non-VPC cluster, it associates the default cluster security group with the cluster.\n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n \n Create a non-VPC cluster.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateCluster\n &ClusterIdentifier=examplecluster\n &MasterUsername=masteruser\n &MasterUserPassword=12345678Aa\n &NumberOfNodes=2 \n &NodeType=dw.hs1.xlarge\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000028Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ****\n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n dw.hs1.xlarge\n examplecluster\n true\n masteruser\n \n \n \n e69b1294-64ef-11e2-b07c-f7fbdd006c67\n \n\n \n \n Create cluster in virtual private cloud (VPC). This example request specifies a ClusterSubnetGroup in the request.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateCluster\n&ClusterIdentifier=exampleclusterinvpc\n&MasterUsername=master\n&MasterUserPassword=1234abcdA\n&NodeType=dw.hs1.xlarge\n&NumberOfNodes=2\n&ClusterSubnetGroupName=mysubnetgroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000028Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ****\n \n mysubnetgroup1\n 1.0\n \n creating\n 2\n 1\n false\n false\n dev\n sat:08:30-sat:09:00\n \n \n in-sync\n default.redshift-1.0\n \n \n vpc-796a5913\n \n dw.hs1.xlarge\n exampleclusterinvpc\n true\n master\n \n \n \n fa337bb4-6a4d-11e2-a12a-cb8076a904bd\n \n\n \n \n " }, "CreateClusterParameterGroup": { "name": "CreateClusterParameterGroup", "input": { "shape_name": "CreateClusterParameterGroupMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group. \n

\n

\n Constraints:\n

\n \n This value is stored as a lower-case string.\n ", "required": true }, "ParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon Redshift engine version to which the \n cluster parameter group applies. The cluster engine version determines the\n set of parameters.

\n

To get a list of valid parameter group family names, you can call \n DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of \n all the parameter groups that are owned by your AWS account, including the default \n parameter groups for each Amazon Redshift engine version. \n The parameter group family names associated with the default parameter groups \n provide you the valid values. For example, a valid family name is \"redshift-1.0\".\n

\n\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the parameter group.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterParameterGroupWrapper", "type": "structure", "members": { "ClusterParameterGroup": { "shape_name": "ClusterParameterGroup", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group family that\n this cluster parameter group is compatible with.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the parameter group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a parameter group.

\n " } } }, "errors": [ { "shape_name": "ClusterParameterGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in the user exceeding the allowed\n number of cluster parameter groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "ClusterParameterGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n A cluster parameter group with the same name already exists.\n

\n " } ], "documentation": "\n

\n Creates an Amazon Redshift parameter group.

\n

Creating parameter groups is independent of creating clusters. \n You can associate a cluster with a parameter group \n when you create the cluster. You can also associate an existing cluster\n with a parameter group after the cluster is created by using ModifyCluster.\n

\n

\n Parameters in the parameter group define specific behavior that applies to the \n databases you create on the cluster. \n \nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterParameterGroup\n &Description=description my parameter group\n &ParameterGroupFamily=redshift-1.0\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T002544Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n redshift-1.0\n description my parameter group\n parametergroup1\n \n \n \n 6d6df847-64f3-11e2-bea9-49e0ce183f07\n \n\n \n " }, "CreateClusterSecurityGroup": { "name": "CreateClusterSecurityGroup", "input": { "shape_name": "CreateClusterSecurityGroupMessage", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the security group.\n Amazon Redshift stores the value as a lowercase string.\n

\n

Constraints:

\n \n

Example: examplesecuritygroup

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description for the security group.\n

\n ", "required": true } }, "documentation": "\n

???

\n " }, "output": { "shape_name": "ClusterSecurityGroupWrapper", "type": "structure", "members": { "ClusterSecurityGroup": { "shape_name": "ClusterSecurityGroup", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group to which the operation was applied.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the EC2 security group.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 Security Group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

Describes an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n A list of EC2 security groups that are permitted to access clusters associated with \n this cluster security group.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the IP range, for example, \"authorized\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range in Classless Inter-Domain Routing (CIDR) notation.\n

\n " } }, "documentation": "\n

\n Describes an IP range used in a security group. \n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n A list of IP ranges (CIDR blocks) that are permitted to access \n clusters associated with this cluster security group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a security group.

\n " } } }, "errors": [ { "shape_name": "ClusterSecurityGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n A cluster security group with the same name already exists.\n

\n " }, { "shape_name": "ClusterSecurityGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in the user exceeding the allowed number of cluster security groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

\n Creates a new Amazon Redshift security group. You use security \n groups to control access to non-VPC clusters. \n

\n

\n \nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSecurityGroup\n &ClusterSecurityGroupName=securitygroup1\n &Description=my security group\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T005817Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n my security group\n securitygroup1\n \n \n \n f9ee270f-64f7-11e2-a8da-655adc216806\n \n\n \n " }, "CreateClusterSnapshot": { "name": "CreateClusterSnapshot", "input": { "shape_name": "CreateClusterSnapshotMessage", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n A unique identifier for the snapshot that you are requesting. This identifier must be unique for \n all snapshots within \n the AWS account.\n

\n

Constraints:

\n \n

Example: my-snapshot-id

\n ", "required": true }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The cluster identifier for which you want a snapshot. \n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n " } } }, "errors": [ { "shape_name": "ClusterSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " }, { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "ClusterSnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

\n " } ], "documentation": "\n

\n Creates a manual snapshot of the specified cluster. \n The cluster must be in the \"available\" state.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSnapshot\n &ClusterIdentifier=examplecluster\n &SnapshotIdentifier=snapshot-1234\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T010824Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 5439\n my-snapshot-123\n creating\n manual\n 1.0\n 2013-01-23T01:08:29.142Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw.hs1.xlarge\n examplecluster\n adminuser\n \n \n \n 65baef14-64f9-11e2-bea9-49e0ce183f07\n \n\n \n " }, "CreateClusterSubnetGroup": { "name": "CreateClusterSubnetGroup", "input": { "shape_name": "CreateClusterSubnetGroupMessage", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name for the subnet group.\n Amazon Redshift stores the value as a lowercase string.\n

\n

Constraints:

\n \n

Example: examplesubnetgroup

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A description for the subnet group.

\n ", "required": true }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

\n An array of VPC subnet IDs. \n A maximum of 20 subnets can be modified in a single request.\n

\n\n ", "required": true } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "ClusterSubnetGroupWrapper", "type": "structure", "members": { "ClusterSubnetGroup": { "shape_name": "ClusterSubnetGroup", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster subnet group.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the cluster subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The VPC ID of the cluster subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster subnet group. Possible values are Complete, \n Incomplete and Invalid.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Describes an availability zone. \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the subnet.\n

\n " } }, "documentation": "\n

\n Describes a subnet.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n A list of the VPC Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a subnet group.

\n " } } }, "errors": [ { "shape_name": "ClusterSubnetGroupAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n A ClusterSubnetGroupName is already used by an existing cluster subnet group.\n

\n " }, { "shape_name": "ClusterSubnetGroupQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in user exceeding the allowed number of cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "ClusterSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " } ], "documentation": "\n

\n Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in \n your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.\n \n

\n

\nFor information about subnet groups, go to\nAmazon Redshift Cluster Subnet Groups in the \nAmazon Redshift Management Guide.\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=CreateClusterSubnetGroup\n &ClusterSubnetGroupName=mysubnetgroup1\n &Description=My subnet group 1\n &SubnetIds.member.1=subnet-756a591f\n &SubnetIds.member.1=subnet-716a591b\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130129/us-east-1/redshift/aws4_request\n &x-amz-date=20130129T192820Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n vpc-796a5913\n My subnet group 1\n mysubnetgroup1\n Complete\n \n \n Active\n subnet-756a591f\n \n us-east-1c\n \n \n \n \n \n \n 0a60660f-6a4a-11e2-aad2-71d00c36728e\n \n\n \n \n " }, "CreateEventSubscription": { "name": "CreateEventSubscription", "input": { "shape_name": "CreateEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the event subscription to be created.\n

\n

Constraints:

\n \n ", "required": true }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by\n Amazon SNS when you create a topic and subscribe to it.\n

\n ", "required": true }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a\n cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all \n Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.\n

\n

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

\n " }, "SourceIds": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

\n A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as\n was specified in the source type parameter. The event subscription will return only events generated by the\n specified objects. If not specified, then events are returned for all objects within the source type specified.\n

\n

Example: my-cluster-1, my-cluster-2

\n

Example: my-snapshot-20131010

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

\n

Values: ERROR, INFO

\n " }, "Enabled": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n A Boolean value; set to true to activate the subscription, set to false to create the\n subscription but not active it.\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the Amazon Redshift event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift event notification subscription.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon Redshift event notification subscription.

\n

Constraints:

\n \n " }, "SubscriptionCreationTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the Amazon Redshift event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type of the events returned the Amazon Redshift event notification, such as cluster, or\n cluster-snapshot.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of the sources that publish events to the Amazon Redshift event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

The list of Amazon Redshift event categories specified in the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

The event severity specified in the Amazon Redshift event notification subscription.

\n

Values: ERROR, INFO

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n " } } }, "errors": [ { "shape_name": "EventSubscriptionQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would exceed the allowed number of event subscriptions for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "SubscriptionAlreadyExistFault", "type": "structure", "members": {}, "documentation": "\n

There is already an existing event notification subscription with the specified name.

\n " }, { "shape_name": "SNSInvalidTopicFault", "type": "structure", "members": {}, "documentation": "\n

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

\n " }, { "shape_name": "SNSNoAuthorizationFault", "type": "structure", "members": {}, "documentation": "\n

You do not have permission to publish to the specified Amazon SNS topic.

\n " }, { "shape_name": "SNSTopicArnNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

\n " }, { "shape_name": "SubscriptionEventIdNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon Redshift event with the specified event ID does not exist.

\n " }, { "shape_name": "SubscriptionCategoryNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The value specified for the event category was not one of the allowed values, or\n it specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

\n " }, { "shape_name": "SubscriptionSeverityNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The value specified for the event severity was not one of the allowed values, or\n it specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

\n " }, { "shape_name": "SourceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified Amazon Redshift event source could not be found.

\n " } ], "documentation": "\n

\n Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of\n an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the \n Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic.\n The ARN is displayed in the SNS console.\n

\n

\n You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities.\n Notifications will be sent for all events you want that match those criteria. For example, you can specify\n source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and\n severity = ERROR. The subsription will only send notifications for those ERROR events in the Availability and\n Backup categores for the specified clusters.\n

\n

\n If you specify both the source type and source IDs, such as source type = cluster and source identifier = \n my-cluster-1, notifiactions will be sent for all the cluster events for my-cluster-1. If you specify a source type\n but do not specify a source identifier, you will receive notice of the events for the objects of that type in your\n AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events\n generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you\n specify a source ID.\n

\n " }, "CreateHsmClientCertificate": { "name": "CreateHsmClientCertificate", "input": { "shape_name": "CreateHsmClientCertificateMessage", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier to be assigned to the new HSM client certificate that the cluster\n will use to connect to the HSM to retrieve the database encryption keys.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "HsmClientCertificateWrapper", "type": "structure", "members": { "HsmClientCertificate": { "shape_name": "HsmClientCertificate", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the HSM client certificate.

\n " }, "HsmClientCertificatePublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key that the Amazon Redshift cluster will use to retrieve the client certificate from the HSM. \n You must register the public key in the HSM.

\n " } }, "wrapper": true, "documentation": "\n

Returns information about an HSM client certificate. The certificate is stored in a secure\n Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to\n encrypt data files.

\n " } } }, "errors": [ { "shape_name": "HsmClientCertificateAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

\n " }, { "shape_name": "HsmClientCertificateQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The quota for HSM client certificates has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM\n in order to store and retrieve the keys used to encrypt the cluster databases.

\n

The command returns a public key, which you must store in the HSM. After creating the HSM certificate,\n you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to\n store and retrieve database encryption keys in the HSM. For more information, go to\n aLinkToHSMTopic in the Amazon Redshift Management Guide.

\n " }, "CreateHsmConfiguration": { "name": "CreateHsmConfiguration", "input": { "shape_name": "CreateHsmConfigurationMessage", "type": "structure", "members": { "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier to be assigned to the new Amazon Redshift HSM configuration.

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A text description of the HSM configuration to be created.

\n ", "required": true }, "HsmIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The IP address that the Amazon Redshift cluster must use to access the HSM.

\n ", "required": true }, "HsmPartitionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the partition in the HSM where the Amazon Redshift clusters will store\n their database encryption keys.

\n ", "required": true }, "HsmPartitionPassword": { "shape_name": "String", "type": "string", "documentation": "\n

The password required to access the HSM partition.

\n ", "required": true }, "HsmServerPublicCertificate": { "shape_name": "String", "type": "string", "documentation": "\n

The public key used to access the HSM client certificate, which was created by calling\n the Amazon Redshift create HSM certificate command.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": { "shape_name": "HsmConfigurationWrapper", "type": "structure", "members": { "HsmConfiguration": { "shape_name": "HsmConfiguration", "type": "structure", "members": { "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift HSM configuration.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A text description of the HSM configuration.

\n " }, "HsmIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The IP address that the Amazon Redshift cluster must use to access the HSM.

\n " }, "HsmPartitionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the partition in the HSM where the Amazon Redshift clusters will store\n their database encryption keys.

\n " } }, "wrapper": true, "documentation": "\n

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift\n clusters the information they require to connect to an HSM where they can store database\n encryption keys.

\n " } } }, "errors": [ { "shape_name": "HsmConfigurationAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

\n " }, { "shape_name": "HsmConfigurationQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The quota for HSM configurations has been reached. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster\n to store and retrieve database encryption keys in a Hardware Storeage Module (HSM). After\n creating the HSM configuration, you can specify it as a parameter when creating a cluster.\n The cluster will then store its encryption keys in the HSM.

\n

Before creating an HSM configuration, you must have first created an HSM client certificate.\n For more information, go to aLinkToHSMTopic in the Amazon Redshift Management Guide.

\n " }, "DeleteCluster": { "name": "DeleteCluster", "input": { "shape_name": "DeleteClusterMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster to be deleted.\n

\n

Constraints:

\n \n ", "required": true }, "SkipFinalClusterSnapshot": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. \n If true, a final cluster snapshot is not created. \n If false, a final cluster snapshot \n is created before the cluster is deleted.\n

\n The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.\n

Default: false

\n " }, "FinalClusterSnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this\n parameter is provided, SkipFinalClusterSnapshot must be false.\n

\n

Constraints:

\n \n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " }, { "shape_name": "ClusterSnapshotAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The value specified as a snapshot identifier is already used by an existing snapshot.\n

\n " }, { "shape_name": "ClusterSnapshotQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in the user exceeding the allowed number of cluster snapshots.\n

\n " } ], "documentation": "\n

\n Deletes a previously provisioned cluster. A successful response\n from the web service indicates that the request was received correctly. If a final cluster snapshot is requested\n 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. Use DescribeClusters \n to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteCluster\n &ClusterIdentifier=examplecluster2\n &SkipFinalClusterSnapshot=true\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T022400Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster2.cobbanlpscsn.us-east-1.redshift.amazonaws.com
\n \n deleting\n 2\n 1\n true\n true\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n 2013-01-23T00:11:32.804Z\n \n \n active\n default\n \n \n us-east-1a\n dw.hs1.xlarge\n examplecluster2\n true\n masteruser\n \n \n \n f2e6b87e-6503-11e2-b343-393adc3f0a21\n \n\n \n " }, "DeleteClusterParameterGroup": { "name": "DeleteClusterParameterGroup", "input": { "shape_name": "DeleteClusterParameterGroupMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter group to be deleted.\n

\n

Constraints:

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidClusterParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

\n " }, { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " } ], "documentation": "\n

\n Deletes a specified Amazon Redshift parameter group. \n You cannot delete a parameter group if it is associated with a cluster. \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T015410Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n 29674ca0-40da-11e2-b679-dba6cf515770\n \n\n \n " }, "DeleteClusterSecurityGroup": { "name": "DeleteClusterSecurityGroup", "input": { "shape_name": "DeleteClusterSecurityGroupMessage", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group to be deleted.\n

\n ", "required": true } }, "documentation": "\n

\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidClusterSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster security group is not \"available\".\n

\n " }, { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " } ], "documentation": "\n

\n Deletes an Amazon Redshift security group. \n

\n You cannot delete a security group that is associated with any clusters. You cannot\n delete the default security group.\n

\nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSecurityGroup\n &ClusterSecurityGroupName=securitygroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T015926Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n e54e05dc-40da-11e2-955f-313c36e9e01d\n \n\n \n " }, "DeleteClusterSnapshot": { "name": "DeleteClusterSnapshot", "input": { "shape_name": "DeleteClusterSnapshotMessage", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the manual snapshot to be deleted.\n

\n

Constraints: Must be the name of an existing snapshot that is in the available state.

\n ", "required": true }, "SnapshotClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n

Constraints: Must be the name of valid cluster.

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n " } } }, "errors": [ { "shape_name": "InvalidClusterSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster snapshot is not \"available\", or other accounts are authorized to access the snapshot.\n

\n " }, { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " } ], "documentation": "\n

\n Deletes the specified manual snapshot. The snapshot must be in the \"available\" state, with no other users authorized to access the snapshot. \n

\n

\n Unlike automated snapshots, manual snapshots are retained even after you \n delete your cluster. \n Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot \n explicitly to avoid getting charged.\n If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSnapshot\n &SnapshotIdentifier=snapshot-1234\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T005225Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 2012-12-07T23:31:02.372Z\n 5439\n snapshot-1234\n deleted\n 2012-12-06T23:09:01.475Z\n manual\n 1.0\n us-east-1a\n examplecluster\n masteruser\n dw.hs1.xlarge\n mydb\n 3\n \n \n \n 88a31de4-40d1-11e2-8a25-eb010998df4e\n \n\n \n " }, "DeleteClusterSubnetGroup": { "name": "DeleteClusterSubnetGroup", "input": { "shape_name": "DeleteClusterSubnetGroupMessage", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster subnet group name to be deleted.

\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [ { "shape_name": "InvalidClusterSubnetGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "InvalidClusterSubnetStateFault", "type": "structure", "members": {}, "documentation": "\n

The state of the subnet is invalid.

\n " }, { "shape_name": "ClusterSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

\n " } ], "documentation": "\n

\n Deletes the specified cluster subnet group.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DeleteClusterSubnetGroup\n &ClusterSubnetGroupName=my-subnet-group-2\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130130/us-east-1/redshift/aws4_request\n &x-amz-date=20130130T154635Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n 3a63806b-6af4-11e2-b27b-4d850b1c672d\n \n\n \n " }, "DeleteEventSubscription": { "name": "DeleteEventSubscription", "input": { "shape_name": "DeleteEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift event notification subscription to be deleted.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon Redshift event notification subscription with the specified name does not exist.

\n " } ], "documentation": "\n

\n Deletes an Amazon Redshift event notification subscription.\n

\n " }, "DeleteHsmClientCertificate": { "name": "DeleteHsmClientCertificate", "input": { "shape_name": "DeleteHsmClientCertificateMessage", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the HSM client certificate to be deleted.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidHsmClientCertificateStateFault", "type": "structure", "members": {}, "documentation": "\n

The specified HSM client certificate is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

\n " }, { "shape_name": "HsmClientCertificateNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM client certificate with the specified identifier.

\n " } ], "documentation": "\n

Deletes the specified HSM client certificate.

\n " }, "DeleteHsmConfiguration": { "name": "DeleteHsmConfiguration", "input": { "shape_name": "DeleteHsmConfigurationMessage", "type": "structure", "members": { "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the Amazon Redshift HSM configuration to be deleted.

\n ", "required": true } }, "documentation": "\n

\n " }, "output": null, "errors": [ { "shape_name": "InvalidHsmConfigurationStateFault", "type": "structure", "members": {}, "documentation": "\n

The specified HSM configuration is not in the available state, or it is still in\n use by one or more Amazon Redshift clusters.

\n " }, { "shape_name": "HsmConfigurationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM configuration with the specified identifier.

\n " } ], "documentation": "\n

Deletes the specified Amazon Redshift HSM configuration.

\n " }, "DescribeClusterParameterGroups": { "name": "DescribeClusterParameterGroups", "input": { "shape_name": "DescribeClusterParameterGroupsMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a specific parameter group for which to return details. By default,\n details about all parameter groups and the default parameter group are returned.\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of parameter group records to include in the response.\n If more records exist than the specified MaxRecords value,\n the response includes a marker that you can use in a subsequent \n DescribeClusterParameterGroups request \n to retrieve the next set of records.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned by a previous DescribeClusterParameterGroups request\n to indicate the first parameter group that the current request will return.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterParameterGroupsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing cluster parameter groups in a new request. \n The response returns a marker if there are more parameter groups to list than \n returned in the response. \n

\n " }, "ParameterGroups": { "shape_name": "ParameterGroupList", "type": "list", "members": { "shape_name": "ClusterParameterGroup", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group family that\n this cluster parameter group is compatible with.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the parameter group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a parameter group.

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n A list of ClusterParameterGroup instances. Each instance describes one cluster parameter\n group.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the DescribeClusterParameterGroups action.\n

\n " }, "errors": [ { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " } ], "documentation": "\n

\n Returns a list of Amazon Redshift parameter groups, including parameter \n groups you created and the default parameter \n group. For each parameter group, the response \n includes the parameter group name, description, and parameter group family name. \n You can optionally specify a name \n to retrieve the description of \n a specific parameter group. \n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterParameterGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T004002Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n\n \n \n \n \n redshift-1.0\n Default parameter group for redshift-1.0\n default.redshift-1.0\n \n \n redshift-1.0\n description my parameter group\n parametergroup1\n \n \n \n \n 6d28788b-64f5-11e2-b343-393adc3f0a21\n \n\n \n " }, "DescribeClusterParameters": { "name": "DescribeClusterParameters", "input": { "shape_name": "DescribeClusterParametersMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a cluster parameter group for which to return details.\n

\n ", "required": true }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The parameter types to return. Specify user to show parameters that are different form the\n default. Similarly, specify engine-default to show parameters that are the same as the default\n parameter group.\n

\n

Default: All parameter types returned.

\n \n

Valid Values: user | engine-default

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n response includes a marker that you can specify in your subsequent request \n to retrieve remaining result.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous DescribeClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the specified marker,\n up to the value specified by MaxRecords. \n

\n " } }, "documentation": "\n\n " }, "output": { "shape_name": "ClusterParameterGroupDetails", "type": "structure", "members": { "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source of the parameter value, such as \"engine-default\" or \"user\".\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " } }, "documentation": "\n

\n Describes a parameter in a cluster parameter group.\n

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n A list of Parameter instances. Each instance lists the parameters of one cluster parameter\n group.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker that indicates the first parameter group that a subsequent\n DescribeClusterParameterGroups request will return.\n The response returns a marker only if there are more parameter groups details to list than \n the current response can return.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the DescribeClusterParameters action.\n

\n " }, "errors": [ { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " } ], "documentation": "\n

\n Returns a detailed list of parameters contained within the specified Amazon Redshift \n parameter group. For each parameter the response includes information \n such as parameter name, description, \n data type, value, whether the parameter value is modifiable, and so on.\n

\n

You can specify source filter to retrieve parameters of only specific type.\n For example, to retrieve parameters that were modified by a user action such as from \n ModifyClusterParameterGroup, you can specify source equal to user.

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterParameters\n &ParameterGroupName=parametergroup1\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T010408Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n ISO, MDY\n string\n engine-default\n true\n Sets the display format for date and time values.\n datestyle\n \n \n 0\n integer\n engine-default\n true\n Sets the number of digits displayed for floating-point values\n -15-2\n extra_float_digits\n \n \n default\n string\n engine-default\n true\n This parameter applies a user-defined label to a group of queries that are run during the same session..\n query_group\n \n \n false\n boolean\n engine-default\n true\n require ssl for all databaseconnections\n true,false\n require_ssl\n \n \n $user, public\n string\n engine-default\n true\n Sets the schema search order for names that are not schema-qualified.\n search_path\n \n \n 0\n integer\n engine-default\n true\n Aborts any statement that takes over the specified number of milliseconds.\n statement_timeout\n \n \n [{"query_concurrency":5}]\n string\n engine-default\n true\n wlm json configuration\n wlm_json_configuration\n \n \n \n \n 2ba35df4-40d3-11e2-82cf-0b45b05c0221\n \n\n \n " }, "DescribeClusterSecurityGroups": { "name": "DescribeClusterSecurityGroups", "input": { "shape_name": "DescribeClusterSecurityGroupsMessage", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a cluster security group for which you are requesting details. \n You can specify either the Marker parameter or a ClusterSecurityGroupName\n parameter, but not both.\n

\n

\n Example: securitygroup1\n

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to be included in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response, which you can use\n in a subsequent DescribeClusterSecurityGroups request. \n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned by a previous DescribeClusterSecurityGroups request\n to indicate the first security group that the current request will return.\n You can specify either the Marker parameter or a ClusterSecurityGroupName\n parameter, but not both.\n

\n " } }, "documentation": "\n

???

\n " }, "output": { "shape_name": "ClusterSecurityGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing cluster security groups in a new request.\n The response returns a marker if there are more security groups to list than \n could be returned in the response.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroups", "type": "list", "members": { "shape_name": "ClusterSecurityGroup", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group to which the operation was applied.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the EC2 security group.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 Security Group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

Describes an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n A list of EC2 security groups that are permitted to access clusters associated with \n this cluster security group.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the IP range, for example, \"authorized\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range in Classless Inter-Domain Routing (CIDR) notation.\n

\n " } }, "documentation": "\n

\n Describes an IP range used in a security group. \n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n A list of IP ranges (CIDR blocks) that are permitted to access \n clusters associated with this cluster security group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of ClusterSecurityGroup instances.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the DescribeClusterSecurityGroups action.\n

\n " }, "errors": [ { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " } ], "documentation": "\n

\n Returns information about Amazon Redshift security groups. \n If the name of a security group is specified, \n the response will contain only information about only that security group. \n

\n

\nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n

\n \n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSecurityGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T010237Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n \n \n 0.0.0.0/0\n authorized\n \n \n default\n default\n \n \n \n \n my security group\n securitygroup1\n \n \n \n \n 947a8305-64f8-11e2-bec0-17624ad140dd\n \n\n \n " }, "DescribeClusterSnapshots": { "name": "DescribeClusterSnapshots", "input": { "shape_name": "DescribeClusterSnapshotsMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which information about snapshots is requested. \n

\n \n " }, "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier of the snapshot about which to return information.\n

\n \n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of snapshots for which you are requesting information. \n By default, snapshots of all types are returned.\n

\n

\n Valid Values: automated | manual\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n A value that requests only snapshots created at or after the specified time. The time\n value is \n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2012-07-16T18:00:00Z

\n " }, "EndTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n A time value that requests only snapshots created at or before the specified time. The time\n value is \n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2012-07-16T18:00:00Z

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of snapshot records to include in the response.\n If more records exist than the specified MaxRecords value,\n the response returns a marker that you can use in a subsequent DescribeClusterSnapshots \n request in order to retrieve the next set of snapshot records.\n

\n

Default: 100

\n

Constraints: Must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned by a previous DescribeClusterSnapshots request\n to indicate the first snapshot that the request will return.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "SnapshotMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker that indicates the first snapshot that a\n subsequent DescribeClusterSnapshots request will return. \n The response returns a marker only if there are more snapshots to list than \n the current response can return. \n

\n " }, "Snapshots": { "shape_name": "SnapshotList", "type": "list", "members": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n ", "xmlname": "Snapshot" }, "documentation": "\n

\n A list of Snapshot instances.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the DescribeClusterSnapshots action.\n

\n " }, "errors": [ { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " } ], "documentation": "\n

\n Returns one or more snapshot objects, which contain metadata about your cluster snapshots.\n By default, this operation returns information about all snapshots of all clusters that are\n owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSnapshots\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T011512Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 5439\n cm:examplecluster-2013-01-22-19-27-58\n available\n automated\n 1.0\n 2013-01-22T19:27:58.931Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw.hs1.xlarge\n examplecluster\n adminuser\n \n \n 5439\n my-snapshot-123\n available\n manual\n 1.0\n 2013-01-23T01:09:03.149Z\n 2\n dev\n 2013-01-22T19:23:59.368Z\n us-east-1c\n dw.hs1.xlarge\n examplecluster\n adminuser\n \n \n \n \n 56a9daf4-64fa-11e2-a8da-655adc216806\n \n\n \n " }, "DescribeClusterSubnetGroups": { "name": "DescribeClusterSubnetGroups", "input": { "shape_name": "DescribeClusterSubnetGroupsMessage", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the cluster subnet group for which information is requested.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The maximum number of cluster subnet group records to include in the response. \n If more records exist than the specified MaxRecords value, the response \n returns a marker that you can use in a subsequent DescribeClusterSubnetGroups\n request in order to retrieve the next set of cluster subnet group records.

\n

Default: 100

\n

Constraints: Must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional marker returned by a previous DescribeClusterSubnetGroups request to indicate the first \n cluster subnet group that the current request will return.

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "ClusterSubnetGroupMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing cluster subnet groups in a new request.\n A marker is returned if there are more cluster subnet groups to list than were returned in the response. \n

\n " }, "ClusterSubnetGroups": { "shape_name": "ClusterSubnetGroups", "type": "list", "members": { "shape_name": "ClusterSubnetGroup", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster subnet group.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the cluster subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The VPC ID of the cluster subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster subnet group. Possible values are Complete, \n Incomplete and Invalid.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Describes an availability zone. \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the subnet.\n

\n " } }, "documentation": "\n

\n Describes a subnet.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n A list of the VPC Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a subnet group.

\n ", "xmlname": "ClusterSubnetGroup" }, "documentation": "\n

\n A list of ClusterSubnetGroup instances.\n

\n " } }, "documentation": "\n

\n Contains the output from the \n DescribeClusterSubnetGroups action.\n

\n " }, "errors": [ { "shape_name": "ClusterSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

\n " } ], "documentation": "\n

\n Returns one or more cluster subnet group objects, which contain metadata about your\n cluster subnet groups. By default, this operation returns information about\n all cluster subnet groups that are defined in you AWS account.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterSubnetGroups\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130130/us-east-1/redshift/aws4_request\n &x-amz-date=20130130T153938Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n vpc-5d917a30\n my subnet group\n my-subnet-group\n Complete\n \n \n Active\n subnet-71c5091c\n \n us-east-1a\n \n \n \n Active\n subnet-78de1215\n \n us-east-1a\n \n \n \n \n \n \n \n 42024b68-6af3-11e2-a726-6368a468fa67\n \n\n \n " }, "DescribeClusterVersions": { "name": "DescribeClusterVersions", "input": { "shape_name": "DescribeClusterVersionsMessage", "type": "structure", "members": { "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The specific cluster version to return.\n

\n

Example: 1.0

\n " }, "ClusterParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of a specific cluster parameter group family to return details for.\n

\n

Constraints:

\n \n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more than the MaxRecords value is available, a marker is\n included in the response so that the following results can be retrieved.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n The marker returned from a previous request.\n If this parameter is specified, the response includes records\n beyond the marker only, up to MaxRecords.\n

\n " } }, "documentation": "\n " }, "output": { "shape_name": "ClusterVersionsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier returned to allow retrieval of paginated results.\n

\n " }, "ClusterVersions": { "shape_name": "ClusterVersionList", "type": "list", "members": { "shape_name": "ClusterVersion", "type": "structure", "members": { "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version number used by the cluster.\n

\n " }, "ClusterParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group family for the cluster.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the cluster version.\n

\n " } }, "documentation": "\n

Describes a cluster version, including the parameter group family and description of\n the version.

\n ", "xmlname": "ClusterVersion" }, "documentation": "\n

\n A list of Version elements.\n

\n " } }, "documentation": "\n

\n Contains the output from the DescribeClusterVersions action.\n

\n " }, "errors": [], "documentation": "\n

\n Returns descriptions of the available Amazon Redshift cluster versions. You can call this \n operation even before creating any clusters to learn more about the Amazon Redshift versions. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusterVersions\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T230708Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n redshift-1.0\n Initial release of redshift\n 1.0\n \n \n \n \n d39cd5e5-40c2-11e2-8a25-eb010998df4e\n \n\n \n " }, "DescribeClusters": { "name": "DescribeClusters", "input": { "shape_name": "DescribeClustersMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of a cluster whose properties you are requesting.\n This parameter isn't case sensitive.\n

\n

The default is that all clusters defined for an account are returned.\n

\n \n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records that the response can include.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response that can be used in a\n new DescribeClusters request to continue listing results.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned by a previous\n DescribeClusters request to indicate the\n first cluster that the current DescribeClusters request will return.\n

\n

You can specify either a Marker parameter or a ClusterIdentifier parameter in a\n DescribeClusters request, but not both.

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClustersMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing clusters in a new request.\n A marker is returned if there are more clusters to list than were\n returned in the response.\n

\n " }, "Clusters": { "shape_name": "ClusterList", "type": "list", "members": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n ", "xmlname": "Cluster" }, "documentation": "\n

\n A list of Cluster objects, where each object describes one cluster. \n

\n " } }, "documentation": "\n

\n Contains the output from the DescribeClusters action.\n

\n " }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " } ], "documentation": "\n

\n Returns properties of provisioned clusters including general cluster properties, cluster database properties,\n maintenance and backup properties, and security and access properties. This operation supports pagination. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n.\n

\n \n \n Describing All Clusters\n The following example shows a request that describes all clusters.\n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeClusters\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T000452Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n ****\n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:10:30-sun:11:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n us-east-1a\n dw.hs1.xlarge\n examplecluster\n true\n masteruser\n \n \n \n \n 837d45d6-64f0-11e2-b07c-f7fbdd006c67\n \n\n \n \n " }, "DescribeDefaultClusterParameters": { "name": "DescribeDefaultClusterParameters", "input": { "shape_name": "DescribeDefaultClusterParametersMessage", "type": "structure", "members": { "ParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group family.\n

\n ", "required": true }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous\n DescribeDefaultClusterParameters request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "DefaultClusterParametersWrapper", "type": "structure", "members": { "DefaultClusterParameters": { "shape_name": "DefaultClusterParameters", "type": "structure", "members": { "ParameterGroupFamily": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group family to which the\n engine default parameters apply.\n

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An identifier to allow retrieval of paginated results.\n

\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source of the parameter value, such as \"engine-default\" or \"user\".\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " } }, "documentation": "\n

\n Describes a parameter in a cluster parameter group.\n

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n The list of cluster default parameters.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes the default cluster parameters for a parameter group family.

\n " } } }, "errors": [], "documentation": "\n

\n Returns a list of parameter settings for the specified parameter group family.\n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeDefaultClusterParameters\n &ParameterGroupFamily=redshift-1.0\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T231708Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n redshift-1.0\n \n \n ISO, MDY\n string\n engine-default\n true\n Sets the display format for date and time values.\n datestyle\n \n \n 0\n integer\n engine-default\n true\n Sets the number of digits displayed for floating-point values\n -15-2\n extra_float_digits\n \n \n default\n string\n engine-default\n true\n This parameter applies a user-defined label to a group of queries that are run during the same session..\n query_group\n \n \n false\n boolean\n engine-default\n true\n require ssl for all databaseconnections\n true,false\n require_ssl\n \n \n $user, public\n string\n engine-default\n true\n Sets the schema search order for names that are not schema-qualified.\n search_path\n \n \n 0\n integer\n engine-default\n true\n Aborts any statement that takes over the specified number of milliseconds.\n statement_timeout\n \n \n [{"query_concurrency":5}]\n string\n engine-default\n true\n wlm json configuration\n wlm_json_configuration\n \n \n \n \n \n 396df00b-40c4-11e2-82cf-0b45b05c0221\n \n\n \n " }, "DescribeEventCategories": { "name": "DescribeEventCategories", "input": { "shape_name": "DescribeEventCategoriesMessage", "type": "structure", "members": { "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source type, such as cluster or parameter group, to which the described\n event categories apply.\n

\n

\n Valid values: cluster, snapshot, parameter group, and security group.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "EventCategoriesMessage", "type": "structure", "members": { "EventCategoriesMapList": { "shape_name": "EventCategoriesMapList", "type": "list", "members": { "shape_name": "EventCategoriesMap", "type": "structure", "members": { "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Redshift source type, such as cluster or cluster-snapshot, that the returned categories belong to.

\n " }, "Events": { "shape_name": "EventInfoMapList", "type": "list", "members": { "shape_name": "EventInfoMap", "type": "structure", "members": { "EventId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of an Amazon Redshift event.

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

The category of an Amazon Redshift event.

\n " }, "EventDescription": { "shape_name": "String", "type": "string", "documentation": "\n

The description of an Amazon Redshift event.

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

The severity of the event.

\n

Values: ERROR, INFO

\n " } }, "wrapper": true, "documentation": "\n ", "xmlname": "EventInfoMap" }, "documentation": "\n

The events in the event category.

\n " } }, "wrapper": true, "documentation": "\n ", "xmlname": "EventCategoriesMap" }, "documentation": "\n

\n A list of event categories descriptions.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "errors": [], "documentation": "\n

Displays a list of event categories for all event source types, or for a\n specified source type. For a list of the event categories and source types,\n go to Amazon Redshift Event Notifications.

\n " }, "DescribeEventSubscriptions": { "name": "DescribeEventSubscriptions", "input": { "shape_name": "DescribeEventSubscriptionsMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift event notification subscription to be described.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value,\n a pagination token called a marker is included in the response so that the remaining results can be retrieved.

\n

Default: 100

\n

Constraints: minimum 20, maximum 100

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional pagination token provided by a previous DescribeOrderableClusterOptions request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "EventSubscriptionsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional pagination token provided by a previous DescribeOrderableClusterOptions request. If this parameter is\n specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.\n

\n " }, "EventSubscriptionsList": { "shape_name": "EventSubscriptionsList", "type": "list", "members": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the Amazon Redshift event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift event notification subscription.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon Redshift event notification subscription.

\n

Constraints:

\n \n " }, "SubscriptionCreationTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the Amazon Redshift event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type of the events returned the Amazon Redshift event notification, such as cluster, or\n cluster-snapshot.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of the sources that publish events to the Amazon Redshift event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

The list of Amazon Redshift event categories specified in the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

The event severity specified in the Amazon Redshift event notification subscription.

\n

Values: ERROR, INFO

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n ", "xmlname": "EventSubscription" }, "documentation": "\n

A list of event subscriptions.

\n " } }, "documentation": "\n

\n " }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon Redshift event notification subscription with the specified name does not exist.

\n " } ], "documentation": "\n

\n Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account.\n If you specify a subscription name, lists the description for that subscription.\n

\n " }, "DescribeEvents": { "name": "DescribeEvents", "input": { "shape_name": "DescribeEventsMessage", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the event source for which events\n will be returned. If this parameter is not specified,\n then all sources are included in the response.\n

\n

Constraints:

\n

If SourceIdentifier is supplied, SourceType must also be provided.

\n \n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot" ], "documentation": "\n

\n The event source to retrieve events for.\n If no value is specified, all events are returned.\n

\n

Constraints:

\n

If SourceType is supplied, SourceIdentifier must also be provided.

\n \n \n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The beginning of the time interval to retrieve events for,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

\n " }, "EndTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The end of the time interval for which to retrieve events,\n specified in ISO 8601 format. For more information about ISO 8601, \n go to the ISO8601 Wikipedia page.\n

\n

Example: 2009-07-08T18:00Z

\n " }, "Duration": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of minutes prior to the time of the request for which to retrieve events. \n For example, if the request is sent at 18:00 and you specify a duration of 60,\n then only events which have occurred after 17:00 will be returned.\n

\n

Default: 60

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: Value must be at least 20 and no more than 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous\n DescribeEvents request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "EventsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing events in a new request.\n The response returns a marker if there are more events to list than \n returned in the response.\n

\n " }, "Events": { "shape_name": "EventList", "type": "list", "members": { "shape_name": "Event", "type": "structure", "members": { "SourceIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the source of the event.\n

\n " }, "SourceType": { "shape_name": "SourceType", "type": "string", "enum": [ "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot" ], "documentation": "\n

\n The source type for this event.\n

\n " }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

\n The text of this event.\n

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

\n A list of the event categories.\n

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

The severity of the event.

\n

Values: ERROR, INFO

\n " }, "Date": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time of the event.\n

\n " }, "EventId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the event.\n

\n " } }, "documentation": "\n

\n Describes an event.\n

\n ", "xmlname": "Event" }, "documentation": "\n

\n A list of Event instances.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the DescribeEvents action.\n

\n " }, "errors": [], "documentation": "\n

\n Returns events related to clusters, security groups, snapshots, and parameter\n groups for the past 14 days. Events specific to a particular cluster, security group,\n snapshot or parameter group can be obtained by providing the name as a parameter.\n By default, the past hour of events are returned.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeEvents\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T232427Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n Cluster security group securitygroup1 has been updated. Changes need to be applied to all clusters using this cluster security group.\n cluster-security-group\n 2012-12-07T23:05:02.660Z\n securitygroup1\n \n \n \n \n 3eeb9efe-40c5-11e2-816a-1bba29fad1f5\n \n\n \n " }, "DescribeHsmClientCertificates": { "name": "DescribeHsmClientCertificates", "input": { "shape_name": "DescribeHsmClientCertificatesMessage", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of a specific HSM client certificate for which you want information. If no\n identifier is specified, information is returned for all HSM client certificates associated\n with Amazon Redshift clusters owned by your AWS customer account.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous\n DescribeOrderableClusterOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "HsmClientCertificateMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing events in a new request.\n The response returns a marker if there are more events to list than \n returned in the response.\n

\n " }, "HsmClientCertificates": { "shape_name": "HsmClientCertificateList", "type": "list", "members": { "shape_name": "HsmClientCertificate", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the HSM client certificate.

\n " }, "HsmClientCertificatePublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key that the Amazon Redshift cluster will use to retrieve the client certificate from the HSM. \n You must register the public key in the HSM.

\n " } }, "wrapper": true, "documentation": "\n

Returns information about an HSM client certificate. The certificate is stored in a secure\n Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to\n encrypt data files.

\n ", "xmlname": "HsmClientCertificate" }, "documentation": "\n

A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters\n to store and retrieve database encryption keys in an HSM.

\n " } }, "documentation": "\n

\n " }, "errors": [ { "shape_name": "HsmClientCertificateNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM client certificate with the specified identifier.

\n " } ], "documentation": "\n

Returns information about the specified HSM client certificate. If no certificate ID is specified,\n returns information about all the HSM certificates owned by your AWS customer account.

\n " }, "DescribeHsmConfigurations": { "name": "DescribeHsmConfigurations", "input": { "shape_name": "DescribeHsmConfigurationsMessage", "type": "structure", "members": { "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of a specific Amazon Redshift HSM configuration to be described. If no\n identifier is specified, information is returned for all HSM configurations\n owned by your AWS customer account.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous\n DescribeOrderableClusterOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "HsmConfigurationMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker at which to continue listing HSM configurations in a new request.\n The response returns a marker if there are more HSM configurations to list than \n returned in the response.\n

\n " }, "HsmConfigurations": { "shape_name": "HsmConfigurationList", "type": "list", "members": { "shape_name": "HsmConfiguration", "type": "structure", "members": { "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift HSM configuration.

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A text description of the HSM configuration.

\n " }, "HsmIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The IP address that the Amazon Redshift cluster must use to access the HSM.

\n " }, "HsmPartitionName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the partition in the HSM where the Amazon Redshift clusters will store\n their database encryption keys.

\n " } }, "wrapper": true, "documentation": "\n

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift\n clusters the information they require to connect to an HSM where they can store database\n encryption keys.

\n ", "xmlname": "HsmConfiguration" }, "documentation": "\n

A list of Amazon Redshift HSM configurations.

\n " } }, "documentation": "\n

\n " }, "errors": [ { "shape_name": "HsmConfigurationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM configuration with the specified identifier.

\n " } ], "documentation": "\n

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is\n specified, returns information about all the HSM configurations owned by your AWS customer account.

\n " }, "DescribeLoggingStatus": { "name": "DescribeLoggingStatus", "input": { "shape_name": "DescribeLoggingStatusMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster to get the logging status from. \n

\n

Example: examplecluster

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "LoggingStatus", "type": "structure", "members": { "LoggingEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

true if logging is on, false if logging is off.

\n " }, "BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the S3 bucket where the log files are stored.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

The prefix applied to the log file names.

\n " }, "LastSuccessfulDeliveryTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs were delivered.\n

\n " }, "LastFailureTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs failed to be delivered.\n

\n " }, "LastFailureMessage": { "shape_name": "String", "type": "string", "documentation": "\n

\n The message indicating that logs failed to be delivered.\n

\n " } }, "documentation": "\n

Describes the status of logging for a cluster.

\n " }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " } ], "documentation": "\n

Describes whether information, such as queries and connection attempts,\n is being logged for the specified Amazon Redshift cluster.

\n " }, "DescribeOrderableClusterOptions": { "name": "DescribeOrderableClusterOptions", "input": { "shape_name": "DescribeOrderableClusterOptionsMessage", "type": "structure", "members": { "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

The version filter value. Specify this parameter to show only \n the available offerings matching the specified version.

\n

Default: All versions.

\n

Constraints: Must be one of the version returned from DescribeClusterVersions.

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned from a previous\n DescribeOrderableClusterOptions request.\n If this parameter is specified, the response includes\n only records beyond the marker,\n up to the value specified by MaxRecords.\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "OrderableClusterOptionsMessage", "type": "structure", "members": { "OrderableClusterOptions": { "shape_name": "OrderableClusterOptionsList", "type": "list", "members": { "shape_name": "OrderableClusterOption", "type": "structure", "members": { "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version of the orderable cluster.\n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The cluster type, for example multi-node.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the orderable cluster. \n

\n " }, "AvailabilityZones": { "shape_name": "AvailabilityZoneList", "type": "list", "members": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Describes an availability zone. \n

\n ", "xmlname": "AvailabilityZone" }, "documentation": "\n

\n A list of availability zones for the orderable cluster. \n

\n " } }, "wrapper": true, "documentation": "\n

\n Describes an orderable cluster option. \n

\n ", "xmlname": "OrderableClusterOption" }, "documentation": "\n

An OrderableClusterOption structure containing information about orderable options for the Cluster.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n A marker that can be used to retrieve paginated results.\n

\n " } }, "documentation": "\n

\n Contains the output from the DescribeOrderableClusterOptions action. \n

\n " }, "errors": [], "documentation": "\n

Returns a list of orderable cluster options. Before you create a \n new cluster you can use this operation to find what options are \n available, such as the EC2 Availability Zones (AZ) in the specific \n AWS region that you can specify, \n and the node types you can request. The node types differ by available \n storage, memory, CPU and price. With the cost involved you might want to \n obtain a list of cluster options in the specific region and specify values \n when creating a cluster. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeOrderableClusterOptions\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T225314Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n multi-node\n dw.hs1.8xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n 1.0\n multi-node\n dw.hs1.xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n 1.0\n single-node\n dw.hs1.xlarge\n \n \n us-east-1a\n \n \n us-east-1c\n \n \n us-east-1d\n \n \n \n \n \n \n e37414cc-40c0-11e2-b6a0-df98b1a86860\n \n\n \n " }, "DescribeReservedNodeOfferings": { "name": "DescribeReservedNodeOfferings", "input": { "shape_name": "DescribeReservedNodeOfferingsMessage", "type": "structure", "members": { "ReservedNodeOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier for the offering.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

\n An optional marker returned by a previous\n DescribeReservedNodeOfferings request to indicate the first offering that the \n request will return.\n

\n

You can specify either a Marker parameter or a ClusterIdentifier parameter in a\n DescribeClusters request, but not both.

\n " } }, "documentation": "\n

to be provided.

\n " }, "output": { "shape_name": "ReservedNodeOfferingsMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional marker returned by a previous DescribeReservedNodeOfferings request \n to indicate the first reserved node offering that the request will return.

\n " }, "ReservedNodeOfferings": { "shape_name": "ReservedNodeOfferingList", "type": "list", "members": { "shape_name": "ReservedNodeOffering", "type": "structure", "members": { "ReservedNodeOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The offering identifier.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type offered by the reserved node offering.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration, in seconds, for which the offering will reserve the node.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The upfront fixed charge you will pay to purchase the specific reserved node offering.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The rate you are charged for each hour the cluster that is using the offering is running.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

\n The currency code for the compute nodes offering.\n

\n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The anticipated utilization of the reserved node, as defined in the reserved node offering.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The amount charged per the period of time specified by the recurring charge frequency.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency at which the recurring charge amount is applied.

\n " } }, "wrapper": true, "documentation": "\n

Describes a recurring charge.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The charge to your account regardless of whether you are creating any clusters using the node offering.\n Recurring charges are only in effect for heavy-utilization reserved nodes.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a reserved node offering.

\n ", "xmlname": "ReservedNodeOffering" }, "documentation": "\n

A list of reserved node offerings.

\n " } }, "documentation": "\n

\n Contains the output from the DescribeReservedNodeOfferings action. \n

\n " }, "errors": [ { "shape_name": "ReservedNodeOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified offering does not exist.\n

\n " } ], "documentation": "\n

\n Returns a list of the\n available reserved node offerings by Amazon Redshift with their descriptions including \n the node type, the fixed and recurring costs of reserving the node and duration the node will \n be reserved for you. These descriptions help you \n determine which reserve node offering you want to purchase. You then use the unique offering ID \n in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your \n Amazon Redshift cluster.\n

\n

\n \nFor more information about managing parameter groups, go to \nPurchasing Reserved Nodes \nin the Amazon Redshift Management Guide.\n \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeReservedNodeOfferings\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130117/us-east-1/redshift/aws4_request\n &x-amz-date=20130117T232351Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 3a98bf7d-979a-49cc-b568-18f24315baf0\n 0.0\n dw.hs1.8xlarge\n \n \n Heavy Utilization\n 31536000\n \n \n Hourly\n 0.09\n \n \n 1815.0\n d586503b-289f-408b-955b-9c95005d6908\n 0.0\n dw.hs1.xlarge\n \n \n \n f4a07e06-60fc-11e2-95d9-658e9466d117\n \n\n \n " }, "DescribeReservedNodes": { "name": "DescribeReservedNodes", "input": { "shape_name": "DescribeReservedNodesMessage", "type": "structure", "members": { "ReservedNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

Identifier for the node reservation.

\n " }, "MaxRecords": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The maximum number of records to include in the response.\n If more records exist than the specified MaxRecords value,\n a marker is included in the response so that the remaining\n results may be retrieved.\n

\n

Default: 100

\n

Constraints: minimum 20, maximum 100.

\n " }, "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

An optional marker returned by a previous DescribeReservedNodes request \n to indicate the first parameter group that the current request will return.

\n " } }, "documentation": "\n

\n

\n " }, "output": { "shape_name": "ReservedNodesMessage", "type": "structure", "members": { "Marker": { "shape_name": "String", "type": "string", "documentation": "\n

A marker that can be used to retrieve paginated results.

\n " }, "ReservedNodes": { "shape_name": "ReservedNodeList", "type": "list", "members": { "shape_name": "ReservedNode", "type": "structure", "members": { "ReservedNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier for the reservation.\n

\n " }, "ReservedNodeOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the reserved node offering.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type of the reserved node.\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time the reservation started. You purchase a reserved node offering for a duration. This is the start\n time of that duration.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration of the node reservation in seconds.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The fixed cost Amazon Redshift charged you for this reserved node.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The hourly rate Amazon Redshift charge you for this reserved node.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

The currency code for the reserved cluster.

\n " }, "NodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of reserved compute nodes.\n

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n The state of the reserved Compute Node. \n

\n

Possible Values:

\n \n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The anticipated utilization of the reserved node, as defined in the reserved node offering.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The amount charged per the period of time specified by the recurring charge frequency.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency at which the recurring charge amount is applied.

\n " } }, "wrapper": true, "documentation": "\n

Describes a recurring charge.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The recurring charges for the reserved node.

\n " } }, "wrapper": true, "documentation": "\n

\n Describes a reserved node.\n

\n ", "xmlname": "ReservedNode" }, "documentation": "\n

The list of reserved nodes.

\n " } }, "documentation": "\n

Contains the output from the DescribeReservedNodes action.

\n " }, "errors": [ { "shape_name": "ReservedNodeNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified reserved compute node not found.\n

\n " } ], "documentation": "\n

\n Returns the descriptions of the reserved nodes.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeReservedNodes\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130125/us-east-1/redshift/aws4_request\n &x-amz-date=20130125T202355Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 2013-01-22T18:46:48.600Z\n Medium Utilization\n 31536000\n \n 800.0\n 0.158\n payment-pending\n dw.hs1.xlarge\n 1\n 4357912c-9266-469d-beb0-0f1b775e1bc9\n \n \n 2013-01-22T20:09:16.630Z\n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 0.0\n payment-pending\n dw.hs1.8xlarge\n 2\n 93bbbca2-e88c-4b8b-a600-b64eaabf18a3\n \n \n 2013-01-23T21:49:32.517Z\n Medium Utilization\n 31536000\n \n 800.0\n 0.158\n payment-pending\n dw.hs1.xlarge\n 1\n bbcd9749-f2ea-4d01-9b1b-b576f618eb4e\n \n \n \n \n 24dc90c8-672d-11e2-b2e1-8f41f0379151\n \n\n \n " }, "DescribeResize": { "name": "DescribeResize", "input": { "shape_name": "DescribeResizeMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of a cluster whose resize progress you are requesting.\n This parameter isn't case-sensitive.\n

\n

By default, resize operations for all clusters defined for an AWS account are returned.\n

\n \n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ResizeProgressMessage", "type": "structure", "members": { "TargetNodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type that the cluster will have after the resize is complete.

\n " }, "TargetNumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of nodes that the cluster will have after the resize is complete.

\n " }, "TargetClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

The cluster type after the resize is complete.

\n

Valid Values: multi-node | single-node

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the resize operation.

\n

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

\n " }, "ImportTablesCompleted": { "shape_name": "ImportTablesCompleted", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The names of tables that have been completely imported .

\n

Valid Values: List of table names.

\n " }, "ImportTablesInProgress": { "shape_name": "ImportTablesInProgress", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The names of tables that are being currently imported.

\n

Valid Values: List of table names.

\n " }, "ImportTablesNotStarted": { "shape_name": "ImportTablesNotStarted", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

The names of tables that have not been yet imported.

\n

Valid Values: List of table names

\n " } }, "documentation": "\n

Describes the result of a cluster resize operation.

\n " }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "ResizeNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

A resize operation for the specified cluster is not found.

\n " } ], "documentation": "\n

\n Returns information about the last resize operation for the specified cluster. \n If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned.\n If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until\n the next resize.\n

\n

\n A resize operation can be requested using \n ModifyCluster and specifying a different number or type of nodes for the cluster.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=DescribeResize\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121207/us-east-1/redshift/aws4_request\n &x-amz-date=20121207T232427Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n multi-node\n SUCCEEDED\n \n users\n venue\n sales\n listing\n event\n date\n category\n \n dw.hs1.xlarge\n 2\n \n \n a6d59c61-a162-11e2-b2bc-fb54c9d11e09\n \n\n \n " }, "DisableLogging": { "name": "DisableLogging", "input": { "shape_name": "DisableLoggingMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster on which logging is to be stopped. \n

\n

Example: examplecluster

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "LoggingStatus", "type": "structure", "members": { "LoggingEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

true if logging is on, false if logging is off.

\n " }, "BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the S3 bucket where the log files are stored.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

The prefix applied to the log file names.

\n " }, "LastSuccessfulDeliveryTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs were delivered.\n

\n " }, "LastFailureTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs failed to be delivered.\n

\n " }, "LastFailureMessage": { "shape_name": "String", "type": "string", "documentation": "\n

\n The message indicating that logs failed to be delivered.\n

\n " } }, "documentation": "\n

Describes the status of logging for a cluster.

\n " }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " } ], "documentation": "\n

Stops logging information, such as queries and connection attempts,\n for the specified Amazon Redshift cluster.

\n " }, "DisableSnapshotCopy": { "name": "DisableSnapshotCopy", "input": { "shape_name": "DisableSnapshotCopyMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.\n

\n

\n Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.\n

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "SnapshotCopyAlreadyDisabledFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster already has cross-region snapshot copy disabled.\n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " } ], "documentation": "\n

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

\n " }, "EnableLogging": { "name": "EnableLogging", "input": { "shape_name": "EnableLoggingMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster on which logging is to be started. \n

\n

Example: examplecluster

\n ", "required": true }, "BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of an existing S3 bucket where the log files are to be stored. \n

\n

Constraints:

\n \n ", "required": true }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

\n The prefix applied to the log file names. \n

\n

Constraints:

\n \n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "LoggingStatus", "type": "structure", "members": { "LoggingEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

true if logging is on, false if logging is off.

\n " }, "BucketName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the S3 bucket where the log files are stored.

\n " }, "S3KeyPrefix": { "shape_name": "String", "type": "string", "documentation": "\n

The prefix applied to the log file names.

\n " }, "LastSuccessfulDeliveryTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs were delivered.\n

\n " }, "LastFailureTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The last time when logs failed to be delivered.\n

\n " }, "LastFailureMessage": { "shape_name": "String", "type": "string", "documentation": "\n

\n The message indicating that logs failed to be delivered.\n

\n " } }, "documentation": "\n

Describes the status of logging for a cluster.

\n " }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "BucketNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Could not find the specified S3 bucket.\n

\n " }, { "shape_name": "InsufficientS3BucketPolicyFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster does not have read bucket or put object permissions\n on the S3 bucket specified when enabling logging.\n

\n " }, { "shape_name": "InvalidS3KeyPrefixFault", "type": "structure", "members": {}, "documentation": "\n

\n The string specified for the logging S3 key prefix does not comply with\n the documented constraints.\n

\n " }, { "shape_name": "InvalidS3BucketNameFault", "type": "structure", "members": {}, "documentation": "\n

The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

\n " } ], "documentation": "\n

Starts logging information, such as queries and connection attempts,\n for the specified Amazon Redshift cluster.

\n " }, "EnableSnapshotCopy": { "name": "EnableSnapshotCopy", "input": { "shape_name": "EnableSnapshotCopyMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the source cluster to copy snapshots from.\n

\n

\n Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.\n

\n ", "required": true }, "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The destination region that you want to copy snapshots to.\n

\n

\n Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference. \n

\n ", "required": true }, "RetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

\n

\n Default: 7.\n

\n

\n Constraints: Must be at least 1 and no more than 35.\n

\n " } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "IncompatibleOrderableOptions", "type": "structure", "members": {}, "documentation": "\n

\n The specified options are incompatible.\n

\n " }, { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " }, { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "CopyToRegionDisabledFault", "type": "structure", "members": {}, "documentation": "\n

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

\n " }, { "shape_name": "SnapshotCopyAlreadyEnabledFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster already has cross-region snapshot copy enabled.\n

\n " }, { "shape_name": "UnknownSnapshotCopyRegionFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified region is incorrect or does not exist.\n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " } ], "documentation": "\n

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

\n " }, "ModifyCluster": { "name": "ModifyCluster", "input": { "shape_name": "ModifyClusterMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster to be modified. \n

\n

Example: examplecluster

\n ", "required": true }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new cluster type.\n

\n

\n When you submit your cluster resize request, your existing cluster goes into a \n read-only mode. After Amazon Redshift provisions a new cluster based on your \n resize requirements, there will be outage for a period while the old cluster is \n deleted and your connection is switched to the new cluster.\n You can use DescribeResize to track the progress of the resize request. \n

\n

Valid Values: multi-node | single-node

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new node type of the cluster. If you specify a new node type, \n you must also specify the number of nodes parameter also.\n

\n

\n When you submit your request to resize a cluster, \n Amazon Redshift sets access permissions for the cluster to read-only.\n After Amazon Redshift provisions a new cluster according to your \n resize requirements, there will be a temporary outage while the old cluster is \n deleted and your connection is switched to the new cluster. When\n the new connection is complete, the original access permissions for the\n cluster are restored.\n You can use the DescribeResize to track the progress of the resize request.\n

\n

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter also.\n

\n

\n When you submit your request to resize a cluster, \n Amazon Redshift sets access permissions for the cluster to read-only.\n After Amazon Redshift provisions a new cluster according to your \n resize requirements, there will be a temporary outage while the old cluster is \n deleted and your connection is switched to the new cluster. When\n the new connection is complete, the original access permissions for the\n cluster are restored.\n You can use DescribeResize to track the progress of the resize request.\n

\n

Valid Values: Integer greater than 0.

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ClusterSecurityGroupName" }, "documentation": "\n

\n A list of cluster security groups to be authorized on this cluster.\n This change is asynchronously applied as soon as possible. \n

\n

Security groups currently associated with the cluster and not in \n the list of groups to apply, will be revoked from the cluster.

\n

Constraints:

\n \n " }, "VpcSecurityGroupIds": { "shape_name": "VpcSecurityGroupIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "VpcSecurityGroupId" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.\n

\n " }, "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new password for the cluster master user.\n This change is asynchronously applied as soon as possible.\n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n \n Operations never return the password, so this operation provides a way to \n regain access to the master user account for a cluster if the password is lost.\n \n

\n

Default: Uses existing setting.

\n

\n Constraints:\n

\n \n " }, "ClusterParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group to apply to this cluster.\n This change is applied only after the cluster is rebooted. To reboot\n a cluster use RebootCluster.\n

\n

Default: Uses existing setting.

\n

Constraints: The cluster parameter group must be in the same \n parameter group family that matches the cluster version.

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The number of days that automated snapshots are retained.\n If the value is 0, automated snapshots are disabled. Even if\n automated snapshots are disabled, you can still create\n manual snapshots when you want with CreateClusterSnapshot.\n

\n

If you decrease the automated snapshot retention period from its current value, \n existing automated snapshots which fall outside of the new retention period will be immediately deleted.

\n

Default: Uses existing setting.

\n

Constraints: Must be a value from 0 to 35.

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which system maintenance can occur, if necessary.\n If system maintenance is necessary during the window, it may result in an outage. \n

\n

\n This maintenance window change is made immediately.\n If the new maintenance window indicates the current time,\n there must be at least 120 minutes between the current time and\n end of the window in order to ensure that pending changes are applied. \n

\n

Default: Uses existing setting.

\n

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

\n

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

\n

Constraints: Must be at least 30 minutes.

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The new version number of the Amazon Redshift engine to upgrade to.\n

\n

\n For major version upgrades, if a non-default cluster parameter group is currently in use,\n a new cluster parameter group in the cluster parameter group family\n for the new version must be specified.\n The new cluster parameter group can be the default for that cluster parameter group family.\n \nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n\n

\n

Example: 1.0

\n " }, "AllowVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n If true, upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n

Default: false

\n " }, "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " }, { "shape_name": "InvalidClusterSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster security group is not \"available\".\n

\n " }, { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "NumberOfNodesQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

\n " }, { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " }, { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " }, { "shape_name": "InsufficientClusterCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

\n " }, { "shape_name": "UnsupportedOptionFault", "type": "structure", "members": {}, "documentation": "\n

An request option was specified that is not supported. \n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " }, { "shape_name": "HsmClientCertificateNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM client certificate with the specified identifier.

\n " }, { "shape_name": "HsmConfigurationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM configuration with the specified identifier.

\n " } ], "documentation": "\n

\n Modifies the settings for a cluster. \n For example, you can add another security or parameter group, \n update the preferred maintenance window, or change the master user password. \n Resetting a cluster password or modifying the security groups associated \n with a cluster do not need a reboot. However, modifying parameter group \n requires a reboot for parameters to take effect. \n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n

You can also change node type and the number of nodes to scale up or down the cluster. \n When resizing a cluster, you must specify\n both the number of nodes and the node type even if one of the parameters does \n not change. If you specify\n the same number of nodes and node type that are already configured for the cluster, \n an error is returned.

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ModifyCluster\n &AllowVersionUpgrade=true\n &AutomatedSnapshotRetentionPeriod=2\n &ClusterIdentifier=examplecluster\n &ClusterParameterGroupName=parametergroup1\n &PreferredMaintenanceWindow=wed:07:30-wed:08:00\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T022911Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com
\n \n available\n 2\n 2\n true\n false\n dev\n wed:07:30-wed:08:00\n \n \n applying\n parametergroup1\n \n \n 2013-01-22T19:23:59.368Z\n \n \n active\n default\n \n \n us-east-1c\n dw.hs1.xlarge\n examplecluster\n true\n adminuser\n \n \n \n acbc43d5-6504-11e2-bea9-49e0ce183f07\n \n\n \n " }, "ModifyClusterParameterGroup": { "name": "ModifyClusterParameterGroup", "input": { "shape_name": "ModifyClusterParameterGroupMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter group to be modified.\n

\n ", "required": true }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source of the parameter value, such as \"engine-default\" or \"user\".\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " } }, "documentation": "\n

\n Describes a parameter in a cluster parameter group.\n

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n An array of parameters to be modified. \n A maximum of 20 parameters can be modified in a single request.\n

\n

\n For each parameter to be modified, you must supply at least the parameter name\n and parameter value; other name-value pairs of the parameter are optional.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterParameterGroupNameMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the parameter group. For example, if you made\n a change to a parameter group name-value pair, then the change could be pending\n a reboot of an associated cluster.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the \n ModifyClusterParameterGroup and ResetClusterParameterGroup actions and\n indicate the parameter group involved and the status of the operation on the \n parameter group.\n

\n " }, "errors": [ { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " }, { "shape_name": "InvalidClusterParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

\n " } ], "documentation": "\n

\n Modifies the parameters of a parameter group. \n

\n

\nFor more information about managing parameter groups, go to \nAmazon Redshift Parameter Groups \nin the Amazon Redshift Management Guide.\n

\n\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ModifyClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Parameters.member.1.ParameterName=extra_float_digits\n &Parameters.member.1.ParameterValue=2\n &Parameters.member.2.ParameterName=wlm_json_configuration\n &Parameters.member.2.ParameterValue=[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T022525Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.\n parametergroup1\n \n \n 86e64043-40de-11e2-8a25-eb010998df4e\n \n\n \n " }, "ModifyClusterSubnetGroup": { "name": "ModifyClusterSubnetGroup", "input": { "shape_name": "ModifyClusterSubnetGroupMessage", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the subnet group to be modified.

\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

A text description of the subnet group to be modified.

\n " }, "SubnetIds": { "shape_name": "SubnetIdentifierList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SubnetIdentifier" }, "documentation": "\n

\n An array of VPC subnet IDs. \n A maximum of 20 subnets can be modified in a single request.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterSubnetGroupWrapper", "type": "structure", "members": { "ClusterSubnetGroup": { "shape_name": "ClusterSubnetGroup", "type": "structure", "members": { "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster subnet group.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n The description of the cluster subnet group.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The VPC ID of the cluster subnet group.\n

\n " }, "SubnetGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster subnet group. Possible values are Complete, \n Incomplete and Invalid.\n

\n " }, "Subnets": { "shape_name": "SubnetList", "type": "list", "members": { "shape_name": "Subnet", "type": "structure", "members": { "SubnetIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the subnet.\n

\n " }, "SubnetAvailabilityZone": { "shape_name": "AvailabilityZone", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the availability zone.\n

\n " } }, "wrapper": true, "documentation": "\n

\n Describes an availability zone. \n

\n " }, "SubnetStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the subnet.\n

\n " } }, "documentation": "\n

\n Describes a subnet.\n

\n ", "xmlname": "Subnet" }, "documentation": "\n

\n A list of the VPC Subnet elements.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a subnet group.

\n " } } }, "errors": [ { "shape_name": "ClusterSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

\n " }, { "shape_name": "ClusterSubnetQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "SubnetAlreadyInUse", "type": "structure", "members": {}, "documentation": "\n

\n A specified subnet is already in use by another cluster.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " } ], "documentation": "\n

\n Modifies a cluster subnet group to include the specified list of VPC subnets. \n The operation replaces the existing list of subnets with the new list of subnets. \n

\n " }, "ModifyEventSubscription": { "name": "ModifyEventSubscription", "input": { "shape_name": "ModifyEventSubscriptionMessage", "type": "structure", "members": { "SubscriptionName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the modified Amazon Redshift event notification subscription.\n

\n ", "required": true }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.\n

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The type of source that will be generating the events. For example, if you want to be notified of events generated by a\n cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all \n Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.\n

\n

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

\n " }, "SourceIds": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

\n A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as\n was specified in the source type parameter. The event subscription will return only events generated by the\n specified objects. If not specified, then events are returned for all objects within the source type specified.\n

\n

Example: my-cluster-1, my-cluster-2

\n

Example: my-snapshot-20131010

\n " }, "EventCategories": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

\n

Values: ERROR, INFO

\n " }, "Enabled": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled\n

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "EventSubscriptionWrapper", "type": "structure", "members": { "EventSubscription": { "shape_name": "EventSubscription", "type": "structure", "members": { "CustomerAwsId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS customer account associated with the Amazon Redshift event notification subscription.

\n " }, "CustSubscriptionId": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the Amazon Redshift event notification subscription.

\n " }, "SnsTopicArn": { "shape_name": "String", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

The status of the Amazon Redshift event notification subscription.

\n

Constraints:

\n \n " }, "SubscriptionCreationTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

The date and time the Amazon Redshift event notification subscription was created.

\n " }, "SourceType": { "shape_name": "String", "type": "string", "documentation": "\n

The source type of the events returned the Amazon Redshift event notification, such as cluster, or\n cluster-snapshot.

\n " }, "SourceIdsList": { "shape_name": "SourceIdsList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SourceId" }, "documentation": "\n

A list of the sources that publish events to the Amazon Redshift event notification subscription.

\n " }, "EventCategoriesList": { "shape_name": "EventCategoriesList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "EventCategory" }, "documentation": "\n

The list of Amazon Redshift event categories specified in the event notification subscription.

\n

Values: Configuration, Management, Monitoring, Security

\n " }, "Severity": { "shape_name": "String", "type": "string", "documentation": "\n

The event severity specified in the Amazon Redshift event notification subscription.

\n

Values: ERROR, INFO

\n " }, "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

\n " } }, "wrapper": true, "documentation": "\n " } } }, "errors": [ { "shape_name": "SubscriptionNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon Redshift event notification subscription with the specified name does not exist.

\n " }, { "shape_name": "SNSInvalidTopicFault", "type": "structure", "members": {}, "documentation": "\n

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

\n " }, { "shape_name": "SNSNoAuthorizationFault", "type": "structure", "members": {}, "documentation": "\n

You do not have permission to publish to the specified Amazon SNS topic.

\n " }, { "shape_name": "SNSTopicArnNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

\n " }, { "shape_name": "SubscriptionEventIdNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

An Amazon Redshift event with the specified event ID does not exist.

\n " }, { "shape_name": "SubscriptionCategoryNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The value specified for the event category was not one of the allowed values, or\n it specified a category that does not apply to the specified source type. The allowed\n values are Configuration, Management, Monitoring, and Security.

\n " }, { "shape_name": "SubscriptionSeverityNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The value specified for the event severity was not one of the allowed values, or\n it specified a severity that does not apply to the specified source type. The allowed\n values are ERROR and INFO.

\n " }, { "shape_name": "SourceNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

The specified Amazon Redshift event source could not be found.

\n " } ], "documentation": "\n

\n Modifies an existing Amazon Redshift event notification subscription.\n

\n " }, "ModifySnapshotCopyRetentionPeriod": { "name": "ModifySnapshotCopyRetentionPeriod", "input": { "shape_name": "ModifySnapshotCopyRetentionPeriodMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.\n

\n

\n Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.\n

\n ", "required": true }, "RetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

\n

\n If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.\n

\n

\n Constraints: Must be at least 1 and no more than 35.\n

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "SnapshotCopyDisabledFault", "type": "structure", "members": {}, "documentation": "\n

\n Cross-region snapshot copy was temporarily disabled. Try your request again.\n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " } ], "documentation": "\n

\n Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.\n

\n " }, "PurchaseReservedNodeOffering": { "name": "PurchaseReservedNodeOffering", "input": { "shape_name": "PurchaseReservedNodeOfferingMessage", "type": "structure", "members": { "ReservedNodeOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identifier of the reserved node offering you want to purchase.

\n ", "required": true }, "NodeCount": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

The number of reserved nodes you want to purchase.

\n

Default: 1

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ReservedNodeWrapper", "type": "structure", "members": { "ReservedNode": { "shape_name": "ReservedNode", "type": "structure", "members": { "ReservedNodeId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier for the reservation.\n

\n " }, "ReservedNodeOfferingId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier for the reserved node offering.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type of the reserved node.\n

\n " }, "StartTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time the reservation started. You purchase a reserved node offering for a duration. This is the start\n time of that duration.\n

\n " }, "Duration": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The duration of the node reservation in seconds.\n

\n " }, "FixedPrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The fixed cost Amazon Redshift charged you for this reserved node.\n

\n " }, "UsagePrice": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The hourly rate Amazon Redshift charge you for this reserved node.\n

\n " }, "CurrencyCode": { "shape_name": "String", "type": "string", "documentation": "\n

The currency code for the reserved cluster.

\n " }, "NodeCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of reserved compute nodes.\n

\n " }, "State": { "shape_name": "String", "type": "string", "documentation": "\n

\n The state of the reserved Compute Node. \n

\n

Possible Values:

\n \n " }, "OfferingType": { "shape_name": "String", "type": "string", "documentation": "\n

The anticipated utilization of the reserved node, as defined in the reserved node offering.

\n " }, "RecurringCharges": { "shape_name": "RecurringChargeList", "type": "list", "members": { "shape_name": "RecurringCharge", "type": "structure", "members": { "RecurringChargeAmount": { "shape_name": "Double", "type": "double", "documentation": "\n

The amount charged per the period of time specified by the recurring charge frequency.

\n " }, "RecurringChargeFrequency": { "shape_name": "String", "type": "string", "documentation": "\n

The frequency at which the recurring charge amount is applied.

\n " } }, "wrapper": true, "documentation": "\n

Describes a recurring charge.

\n ", "xmlname": "RecurringCharge" }, "documentation": "\n

The recurring charges for the reserved node.

\n " } }, "wrapper": true, "documentation": "\n

\n Describes a reserved node.\n

\n " } } }, "errors": [ { "shape_name": "ReservedNodeOfferingNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n Specified offering does not exist.\n

\n " }, { "shape_name": "ReservedNodeAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n User already has a reservation with the given identifier.\n

\n " }, { "shape_name": "ReservedNodeQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n Request would exceed the user's compute node quota. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " } ], "documentation": "\n

\n Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings.\n You can purchase one of the offerings. You can call the\n DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this \n API by providing a specific reserved node offering and the number of nodes you want to reserve.\n

\n

\n \nFor more information about managing parameter groups, go to \nPurchasing Reserved Nodes \nin the Amazon Redshift Management Guide.\n \n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=PurchaseReservedNodeOffering\n &ReservedNodeOfferingId=3a98bf7d-979a-49cc-b568-18f24315baf0\n &NodeCount=2\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130117/us-east-1/redshift/aws4_request\n &x-amz-date=20130117T232351Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n 2013-01-18T21:42:44.402Z\n Heavy Utilization\n 94608000\n \n \n Hourly\n 0.21\n \n \n 12452.0\n 0.0\n payment-pending\n dw.hs1.8xlarge\n 2\n 1ba8e2e3-dacf-48d9-841f-cc675182a8a6\n \n \n \n fcb117cc-61b7-11e2-b6e9-87e586e4ca38\n \n\n \n " }, "RebootCluster": { "name": "RebootCluster", "input": { "shape_name": "RebootClusterMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The cluster identifier.\n

\n ", "required": true } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " }, { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " } ], "documentation": "\n

\n Reboots a cluster. \n This action is taken as soon as possible. It results in a momentary outage to the cluster,\n during which the cluster status is set to rebooting. A cluster event is created\n when the reboot is completed. \n Any pending cluster modifications (see ModifyCluster) are applied at this reboot.\n \nFor more information about managing clusters, go to \nAmazon Redshift Clusters \nin the Amazon Redshift Management Guide\n\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RebootCluster\n &ClusterIdentifier=examplecluster\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T021951Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n \n 5439\n
examplecluster.cobaosmlqshn.us-east-1.redshift.amazonaws.com
\n \n rebooting\n 2\n 1\n true\n false\n dev\n sun:06:30-sun:07:00\n \n \n in-sync\n default.redshift-1.0\n \n \n 2013-01-22T19:23:59.368Z\n \n \n active\n default\n \n \n us-east-1c\n dw.hs1.xlarge\n examplecluster\n true\n adminuser\n \n \n \n 5edee79e-6503-11e2-9e70-918437dd236d\n \n\n \n " }, "ResetClusterParameterGroup": { "name": "ResetClusterParameterGroup", "input": { "shape_name": "ResetClusterParameterGroupMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group to be reset.\n

\n ", "required": true }, "ResetAllParameters": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, all parameters\n in the specified parameter group will be reset to their default values.\n

\n

Default: true

\n " }, "Parameters": { "shape_name": "ParametersList", "type": "list", "members": { "shape_name": "Parameter", "type": "structure", "members": { "ParameterName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the parameter.\n

\n " }, "ParameterValue": { "shape_name": "String", "type": "string", "documentation": "\n

\n The value of the parameter.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the parameter.\n

\n " }, "Source": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source of the parameter value, such as \"engine-default\" or \"user\".\n

\n " }, "DataType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The data type of the parameter.\n

\n " }, "AllowedValues": { "shape_name": "String", "type": "string", "documentation": "\n

\n The valid range of values for the parameter.\n

\n " }, "IsModifiable": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, the parameter can be modified.\n Some parameters have security or operational implications\n that prevent them from being changed.\n

\n " }, "MinimumEngineVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The earliest engine version to which the parameter can apply.\n

\n " } }, "documentation": "\n

\n Describes a parameter in a cluster parameter group.\n

\n ", "xmlname": "Parameter" }, "documentation": "\n

\n An array of names of parameters to be reset. If ResetAllParameters option is not used, \n then at least one parameter name must be supplied. \n

\n

Constraints: A maximum of 20 parameters can be reset in a single request.

\n \n " } }, "documentation": "\n

\n\n

\n " }, "output": { "shape_name": "ClusterParameterGroupNameMessage", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterGroupStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the parameter group. For example, if you made\n a change to a parameter group name-value pair, then the change could be pending\n a reboot of an associated cluster.\n

\n " } }, "documentation": "\n

\n\t\tContains the output from the \n ModifyClusterParameterGroup and ResetClusterParameterGroup actions and\n indicate the parameter group involved and the status of the operation on the \n parameter group.\n

\n " }, "errors": [ { "shape_name": "InvalidClusterParameterGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster parameter group action can not be completed because \n another task is in progress that involves the parameter group. \n Wait a few moments and try the operation again.\n

\n " }, { "shape_name": "ClusterParameterGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The parameter group name does not refer to an\n existing parameter group.\n

\n " } ], "documentation": "\n

\n Sets one or more parameters of the specified parameter group to their default values and sets the \n source values of the parameters to \"engine-default\". \n To reset the entire parameter group specify the ResetAllParameters parameter. \n For parameter changes to take effect you must reboot any associated clusters.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=ResetClusterParameterGroup\n &ParameterGroupName=parametergroup1\n &Parameters.member.1.ParameterName=extra_float_digits\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20121208/us-east-1/redshift/aws4_request\n &x-amz-date=20121208T020847Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.\n parametergroup1\n \n \n 625d23c1-40dc-11e2-8a25-eb010998df4e\n \n\n \n " }, "RestoreFromClusterSnapshot": { "name": "RestoreFromClusterSnapshot", "input": { "shape_name": "RestoreFromClusterSnapshotMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster that will be created from restoring the snapshot.\n

\n

\n \n

Constraints:

\n\n\n

\n ", "required": true }, "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the snapshot from which to create the new cluster.\n This parameter isn't case sensitive. \n

\n

Example: my-snapshot-id

\n ", "required": true }, "SnapshotClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n " }, "Port": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The port number on which the cluster accepts connections.\n

\n

Default: The same port as the original cluster.

\n

Constraints: Must be between 1115 and 65535.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Amazon EC2 Availability Zone in which to restore the cluster.\n

\n

Default: A random, system-chosen Availability Zone.

\n

Example: us-east-1a

\n " }, "AllowVersionUpgrade": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n If true, upgrades can be applied during the maintenance window to the \n Amazon Redshift engine that is running on the cluster.\n

\n

Default: true

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group where you want to cluster restored. \n

\n

\n A snapshot of cluster in VPC can be restored only in VPC. Therefore, \n you must provide subnet group name where you want the cluster restored.\n

\n " }, "PubliclyAccessible": { "shape_name": "BooleanOptional", "type": "boolean", "documentation": "\n

\n If true, the cluster can be accessed from a public network.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. \n

\n " }, "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " } }, "documentation": "\n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "AccessToSnapshotDeniedFault", "type": "structure", "members": {}, "documentation": "\n

\n The owner of the specified snapshot has not authorized your account to access the snapshot.\n

\n " }, { "shape_name": "ClusterAlreadyExistsFault", "type": "structure", "members": {}, "documentation": "\n

\n The account already has a cluster with the given identifier.\n

\n " }, { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " }, { "shape_name": "ClusterQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

\n The request would exceed the allowed number of cluster instances for this account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n\n

\n " }, { "shape_name": "InsufficientClusterCapacityFault", "type": "structure", "members": {}, "documentation": "\n

\n The number of nodes specified exceeds the allotted capacity of the cluster.\n

\n " }, { "shape_name": "InvalidClusterSnapshotStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster snapshot is not \"available\", or other accounts are authorized to access the snapshot.\n

\n " }, { "shape_name": "InvalidRestoreFault", "type": "structure", "members": {}, "documentation": "\n

The restore is invalid.

\n " }, { "shape_name": "NumberOfNodesQuotaExceededFault", "type": "structure", "members": {}, "documentation": "\n

The operation would exceed the number of nodes allotted to the account. \nFor information about increasing your quota, go to Limits in Amazon Redshift \nin the Amazon Redshift Management Guide.\n

\n " }, { "shape_name": "NumberOfNodesPerClusterLimitExceededFault", "type": "structure", "members": {}, "documentation": "\n

The operation would exceed the number of nodes allowed for a cluster.

\n " }, { "shape_name": "InvalidVPCNetworkStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group does not cover all Availability Zones.\n

\n " }, { "shape_name": "InvalidClusterSubnetGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group cannot be deleted because it is in use.\n

\n " }, { "shape_name": "InvalidSubnet", "type": "structure", "members": {}, "documentation": "\n

\n The requested subnet is not valid, or not all of the subnets are in the same VPC. \n

\n " }, { "shape_name": "ClusterSubnetGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster subnet group name does not refer to an existing cluster subnet group.\n

\n " }, { "shape_name": "UnauthorizedOperation", "type": "structure", "members": {}, "documentation": "\n

\n Your account is not authorized to perform the requested operation.\n

\n " }, { "shape_name": "HsmClientCertificateNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM client certificate with the specified identifier.

\n " }, { "shape_name": "HsmConfigurationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

There is no Amazon Redshift HSM configuration with the specified identifier.

\n " }, { "shape_name": "InvalidElasticIpFault", "type": "structure", "members": {}, "documentation": "\n

The Elastic IP (EIP) is invalid or cannot be found.

\n " } ], "documentation": "\n

\n \n Creates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster \n with the same configuration as the original cluster from which the snapshot was created, \n except that the new cluster\n is created with the default cluster security and parameter group. \n \n After Amazon Redshift creates the cluster you can use the ModifyCluster \n API to associate a different security group and different parameter group with the\n restored cluster.\n \n \n

\n

If a snapshot is taken of a cluster in VPC, you can restore it only in VPC. \n In this case, you must provide a cluster subnet group where you want the cluster \n restored. If snapshot is taken of a cluster outside VPC, then you can \n restore it only outside VPC.

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RestoreFromClusterSnapshot\n &ClusterIdentifier=examplecluster-restored\n &SnapshotIdentifier=cm:examplecluster-2013-01-22-19-27-58\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T023350Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n 1.0\n \n creating\n 2\n 1\n true\n false\n dev\n sun:06:30-sun:07:00\n \n \n in-sync\n default.redshift-1.0\n \n \n \n \n active\n default\n \n \n dw.hs1.xlarge\n examplecluster-restored\n true\n adminuser\n \n \n \n 52a9aee8-6505-11e2-bec0-17624ad140dd\n \n\n \n " }, "RevokeClusterSecurityGroupIngress": { "name": "RevokeClusterSecurityGroupIngress", "input": { "shape_name": "RevokeClusterSecurityGroupIngressMessage", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the security Group from which to revoke the ingress rule.\n

\n ", "required": true }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range for which to revoke access. \n This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. \n If CIDRIP is specified,\n EC2SecurityGroupName and EC2SecurityGroupOwnerId\n cannot be provided.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 Security Group whose access is to be revoked.\n If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId \n must also be provided and CIDRIP cannot be provided.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS account number of the owner of the security group\n specified in the EC2SecurityGroupName parameter.\n The AWS access key ID is not an acceptable value.\n If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName \n must also be provided. and CIDRIP cannot be provided.\n

\n

Example: 111122223333

\n " } }, "documentation": "\n

\n ???\n

\n " }, "output": { "shape_name": "ClusterSecurityGroupWrapper", "type": "structure", "members": { "ClusterSecurityGroup": { "shape_name": "ClusterSecurityGroup", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group to which the operation was applied.\n

\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n

\n A description of the security group.\n

\n " }, "EC2SecurityGroups": { "shape_name": "EC2SecurityGroupList", "type": "list", "members": { "shape_name": "EC2SecurityGroup", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the EC2 security group.\n

\n " }, "EC2SecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the EC2 Security Group.\n

\n " }, "EC2SecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The AWS ID of the owner of the EC2 security group\n specified in the EC2SecurityGroupName field.\n

\n " } }, "documentation": "\n

Describes an Amazon EC2 security group.

\n ", "xmlname": "EC2SecurityGroup" }, "documentation": "\n

\n A list of EC2 security groups that are permitted to access clusters associated with \n this cluster security group.\n

\n " }, "IPRanges": { "shape_name": "IPRangeList", "type": "list", "members": { "shape_name": "IPRange", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the IP range, for example, \"authorized\".\n

\n " }, "CIDRIP": { "shape_name": "String", "type": "string", "documentation": "\n

\n The IP range in Classless Inter-Domain Routing (CIDR) notation.\n

\n " } }, "documentation": "\n

\n Describes an IP range used in a security group. \n

\n ", "xmlname": "IPRange" }, "documentation": "\n

\n A list of IP ranges (CIDR blocks) that are permitted to access \n clusters associated with this cluster security group.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a security group.

\n " } } }, "errors": [ { "shape_name": "ClusterSecurityGroupNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The cluster security group name does not refer to an existing cluster security group.\n

\n " }, { "shape_name": "AuthorizationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified CIDR IP range or EC2 security group is not authorized\n for the specified cluster security group.\n

\n " }, { "shape_name": "InvalidClusterSecurityGroupStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The state of the cluster security group is not \"available\".\n

\n " } ], "documentation": "\n

\n Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or \n Amazon EC2 security group. To add\n an ingress rule, see AuthorizeClusterSecurityGroupIngress. \n \nFor information about managing security groups, go to\nAmazon Redshift Cluster Security Groups in the \nAmazon Redshift Management Guide.\n\n

\n\n \n https://redshift.us-east-1.amazonaws.com/\n ?Action=RevokeClusterSecurityGroupIngress\n &ClusterSecurityGroupName=securitygroup1\n &CIDRIP=192.168.40.3/32\n &Version=2012-12-01\n &x-amz-algorithm=AWS4-HMAC-SHA256\n &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request\n &x-amz-date=20130123T021606Z\n &x-amz-signedheaders=content-type;host;x-amz-date\n \n \n \n \n \n my security group\n securitygroup1\n \n \n \n d8eff363-6502-11e2-a8da-655adc216806\n \n\n \n " }, "RevokeSnapshotAccess": { "name": "RevokeSnapshotAccess", "input": { "shape_name": "RevokeSnapshotAccessMessage", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the snapshot that the account can no longer access. \n

\n ", "required": true }, "SnapshotClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.\n

\n " }, "AccountWithRestoreAccess": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the AWS customer account that can no longer restore the specified snapshot. \n

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "SnapshotWrapper", "type": "structure", "members": { "Snapshot": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot identifier that is provided in the request.\n

\n " }, "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of the cluster for which the snapshot was taken.\n

\n " }, "SnapshotCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when Amazon Redshift began the snapshot. \n A snapshot contains a copy of the cluster data as of this exact time. \n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot status. The value of the status depends on the API operation used.\n

\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the cluster is listening on.\n

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The Availability Zone in which the cluster was created.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The time (UTC) when the cluster was originally created.\n

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "SnapshotType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

The node type of the nodes in the cluster.

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of nodes in the cluster.

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the database that was created when the cluster was created.

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise,\n this field is not in the output.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the data in the snapshot is encrypted at rest.

\n " }, "EncryptedWithHSM": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

A boolean that indicates whether the snapshot data is encrypted using the HSM keys\n of the source cluster. true indicates that the data is encrypted using HSM keys.

\n " }, "AccountsWithRestoreAccess": { "shape_name": "AccountsWithRestoreAccessList", "type": "list", "members": { "shape_name": "AccountWithRestoreAccess", "type": "structure", "members": { "AccountId": { "shape_name": "String", "type": "string", "documentation": "\n

\n The identifier of an AWS customer account authorized to restore a snapshot. \n

\n " } }, "documentation": "\n

\n Describes an AWS customer account authorized to restore a snapshot. \n

\n ", "xmlname": "AccountWithRestoreAccess" }, "documentation": "\n

\n A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.\n

\n " }, "OwnerAccount": { "shape_name": "String", "type": "string", "documentation": "\n

\n For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.\n

\n " }, "TotalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the complete set of backup data that would be used to restore the cluster.\n

\n " }, "ActualIncrementalBackupSizeInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The size of the incremental backup.\n

\n " }, "BackupProgressInMegaBytes": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes that have been transferred to the snapshot backup.\n

\n " }, "CurrentBackupRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.\n

\n " }, "EstimatedSecondsToCompletion": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup. \n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.\n

\n " }, "SourceRegion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The source region from which the snapshot was copied.\n

\n " } }, "wrapper": true, "documentation": "\n

Describes a snapshot.

\n " } } }, "errors": [ { "shape_name": "AccessToSnapshotDeniedFault", "type": "structure", "members": {}, "documentation": "\n

\n The owner of the specified snapshot has not authorized your account to access the snapshot.\n

\n " }, { "shape_name": "AuthorizationNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified CIDR IP range or EC2 security group is not authorized\n for the specified cluster security group.\n

\n " }, { "shape_name": "ClusterSnapshotNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The snapshot identifier does not refer to an existing cluster snapshot.\n

\n " } ], "documentation": "\n

\n Removes the ability of the specified AWS customer account to restore the specified snapshot.\n If the account is currently restoring the snapshot, the restore will run to completion.\n

\n

\nFor more information about working with snapshots, go to \nAmazon Redshift Snapshots \nin the Amazon Redshift Management Guide.\n

\n " }, "RotateEncryptionKey": { "name": "RotateEncryptionKey", "input": { "shape_name": "RotateEncryptionKeyMessage", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster that you want to rotate the encryption keys for.\n

\n

\n Constraints: Must be the name of valid cluster that has encryption enabled.\n

\n ", "required": true } }, "documentation": "\n

\n \n

\n " }, "output": { "shape_name": "ClusterWrapper", "type": "structure", "members": { "Cluster": { "shape_name": "Cluster", "type": "structure", "members": { "ClusterIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

\n The unique identifier of the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The node type for the nodes in the cluster.\n

\n " }, "ClusterStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The current state of this cluster. Possible values include\n available, creating, deleting, \n rebooting, and resizing.\n

\n " }, "ModifyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

The status of a modify operation, if any, initiated for the cluster.

\n " }, "MasterUsername": { "shape_name": "String", "type": "string", "documentation": "\n

\n The master user name for the cluster. \n This name is used to connect to the database that is specified in DBName.\n

\n " }, "DBName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the initial database that was created when the \n cluster was created. This same name is returned for\n the life of the cluster. If an initial database was not specified,\n a database named \"dev\" was created by default.\n

\n " }, "Endpoint": { "shape_name": "Endpoint", "type": "structure", "members": { "Address": { "shape_name": "String", "type": "string", "documentation": "\n

\n The DNS address of the Cluster.\n

\n " }, "Port": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The port that the database engine is listening on.\n

\n " } }, "documentation": "\n

\n The connection endpoint.\n

\n " }, "ClusterCreateTime": { "shape_name": "TStamp", "type": "timestamp", "documentation": "\n

\n The date and time that the cluster was created.\n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of days that automatic cluster snapshots are retained.\n

\n " }, "ClusterSecurityGroups": { "shape_name": "ClusterSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "ClusterSecurityGroupMembership", "type": "structure", "members": { "ClusterSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster security group.\n

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the cluster security group.\n

\n " } }, "documentation": "\n

Describes a security group.

\n ", "xmlname": "ClusterSecurityGroup" }, "documentation": "\n

\n A list of cluster security group that are associated with the cluster. Each\n security group is represented by an element that contains \n ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.\n

\n

Cluster security groups are used when the cluster is not created in a VPC.\n Clusters that are created in a VPC use VPC security groups, which are \n listed by the VpcSecurityGroups parameter. \n

\n " }, "VpcSecurityGroups": { "shape_name": "VpcSecurityGroupMembershipList", "type": "list", "members": { "shape_name": "VpcSecurityGroupMembership", "type": "structure", "members": { "VpcSecurityGroupId": { "shape_name": "String", "type": "string", "documentation": "\n \n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n \n " } }, "documentation": "\n

Describes the members of a VPC security group.

\n ", "xmlname": "VpcSecurityGroup" }, "documentation": "\n

\n A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. \n This parameter is returned only if the cluster is in a VPC.\n

\n " }, "ClusterParameterGroups": { "shape_name": "ClusterParameterGroupStatusList", "type": "list", "members": { "shape_name": "ClusterParameterGroupStatus", "type": "structure", "members": { "ParameterGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the cluster parameter group.\n

\n " }, "ParameterApplyStatus": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of parameter updates.\n

\n " } }, "documentation": "\n

\n Describes the status of a parameter group.\n

\n ", "xmlname": "ClusterParameterGroup" }, "documentation": "\n

\n The list of cluster parameter groups that are associated with this cluster.\n

\n " }, "ClusterSubnetGroupName": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the subnet group that is associated with the cluster.\n This parameter is valid only when the cluster is in a VPC.\n

\n " }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n

\n The name of the Availability Zone in which the cluster is located.\n

\n " }, "PreferredMaintenanceWindow": { "shape_name": "String", "type": "string", "documentation": "\n

\n The weekly time range (in UTC) during which\n system maintenance can occur.\n

\n " }, "PendingModifiedValues": { "shape_name": "PendingModifiedValues", "type": "structure", "members": { "MasterUserPassword": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the master password for the cluster.\n

\n " }, "NodeType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster's node type.\n

\n " }, "NumberOfNodes": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the number nodes in the cluster. \n

\n " }, "ClusterType": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the cluster type.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The pending or in-progress change of the service version. \n

\n " }, "AutomatedSnapshotRetentionPeriod": { "shape_name": "IntegerOptional", "type": "integer", "documentation": "\n

\n The pending or in-progress change of the automated snapshot retention period. \n

\n " } }, "documentation": "\n

\n If present, changes to the cluster are pending.\n Specific pending changes are identified by subelements.\n

\n " }, "ClusterVersion": { "shape_name": "String", "type": "string", "documentation": "\n

\n The version ID of the Amazon Redshift engine that is running on the cluster.\n

\n " }, "AllowVersionUpgrade": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

\n If true, version upgrades will be applied automatically\n to the cluster during the maintenance window.\n

\n " }, "NumberOfNodes": { "shape_name": "Integer", "type": "integer", "documentation": "\n

\n The number of compute nodes in the cluster.\n

\n " }, "PubliclyAccessible": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, the cluster can be accessed from a public network.

\n " }, "Encrypted": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

If true, data in cluster is encrypted at rest.

\n " }, "RestoreStatus": { "shape_name": "RestoreStatus", "type": "structure", "members": { "Status": { "shape_name": "String", "type": "string", "documentation": "\n

\n The status of the restore action. Returns starting, restoring, completed, or failed.\n

\n " }, "CurrentRestoreRateInMegaBytesPerSecond": { "shape_name": "Double", "type": "double", "documentation": "\n

\n The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.\n

\n " }, "SnapshotSizeInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The size of the set of snapshot data used to restore the cluster.\n

\n " }, "ProgressInMegaBytes": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The number of megabytes that have been transferred from snapshot storage.\n

\n " }, "ElapsedTimeInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.\n

\n " }, "EstimatedTimeToCompletionInSeconds": { "shape_name": "Long", "type": "long", "documentation": "\n

\n The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.\n

\n " } }, "documentation": "\n

\n Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.\n

\n " }, "HsmStatus": { "shape_name": "HsmStatus", "type": "structure", "members": { "HsmClientCertificateIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data\n encryption keys stored in an HSM.

\n " }, "HsmConfigurationIdentifier": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster\n can use to retrieve and store keys in an HSM.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " } }, "documentation": "\n

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes\n specified in a modify cluster command.

\n

Values: active, applying

\n " }, "ClusterSnapshotCopyStatus": { "shape_name": "ClusterSnapshotCopyStatus", "type": "structure", "members": { "DestinationRegion": { "shape_name": "String", "type": "string", "documentation": "\n

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

\n " }, "RetentionPeriod": { "shape_name": "Long", "type": "long", "documentation": "\n

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

\n " } }, "documentation": "\n

\n Returns the destination region and retention period that are configured for cross-region snapshot copy.\n

\n " }, "ClusterPublicKey": { "shape_name": "String", "type": "string", "documentation": "\n

The public key for the cluster.

\n " }, "ClusterNodes": { "shape_name": "ClusterNodesList", "type": "list", "members": { "shape_name": "ClusterNode", "type": "structure", "members": { "NodeRole": { "shape_name": "String", "type": "string", "documentation": "\n

Whether the node is a leader node or a compute node.

\n " }, "PrivateIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The private IP address of a node within a cluster.

\n " }, "PublicIPAddress": { "shape_name": "String", "type": "string", "documentation": "\n

The public IP address of a node within a cluster.

\n " } }, "documentation": "\n

The identifier of a node in a cluster. -->

\n " }, "documentation": "\n

The nodes in a cluster.

\n " }, "ElasticIpStatus": { "shape_name": "ElasticIpStatus", "type": "structure", "members": { "ElasticIp": { "shape_name": "String", "type": "string", "documentation": "\n

The elastic IP (EIP) address for the cluster.

\n " }, "Status": { "shape_name": "String", "type": "string", "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "documentation": "\n

Describes the status of the elastic IP (EIP) address.

\n " } }, "wrapper": true, "documentation": "\n

Describes a cluster.

\n " } } }, "errors": [ { "shape_name": "ClusterNotFoundFault", "type": "structure", "members": {}, "documentation": "\n

\n The ClusterIdentifier parameter does not refer to an existing cluster.\n

\n " }, { "shape_name": "InvalidClusterStateFault", "type": "structure", "members": {}, "documentation": "\n

\n The specified cluster is not in the available state.\n

\n " } ], "documentation": "\n

\n Rotates the encryption keys for a cluster.\n

\n " } }, "metadata": { "regions": { "us-east-1": null, "us-west-2": null, "eu-west-1": null, "ap-northeast-1": null, "ap-southeast-1": null, "ap-southeast-2": null }, "protocols": [ "https" ] }, "waiters": { "ClusterAvailable": { "success": { "path": "Clusters[].ClusterStatus", "type": "output", "value": [ "available" ] }, "interval": 60, "failure": { "path": "Clusters[].ClusterStatus", "type": "output", "value": [ "deleting" ] }, "ignore_errors": [ "ClusterNotFound" ], "operation": "DescribeClusters", "max_attempts": 30 }, "SnapshotAvailable": { "failure": { "path": "Snapshots[].Status", "type": "output", "value": [ "failed", "deleted" ] }, "operation": "DescribeClusterSnapshots", "success": { "path": "Snapshots[].Status", "type": "output", "value": [ "available" ] }, "interval": 15, "max_attempts": 20 }, "ClusterDeleted": { "success": { "path": "Clusters[].ClusterStatus", "type": "error", "value": [ "ClusterNotFound" ] }, "interval": 60, "failure": { "path": "Clusters[].ClusterStatus", "type": "output", "value": [ "creating", "rebooting" ] }, "operation": "DescribeClusters", "max_attempts": 30 } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/route53.json0000644000175000017500000042076312254746564020463 0ustar takakitakaki{ "api_version": "2012-12-12", "type": "rest-xml", "signature_version": "v3https", "service_full_name": "Amazon Route 53", "service_abbreviation": "Route 53", "global_endpoint": "route53.amazonaws.com", "endpoint_prefix": "route53", "xmlnamespace": "https://route53.amazonaws.com/doc/2012-12-12/", "documentation": "\n ", "operations": { "ChangeResourceRecordSets": { "name": "ChangeResourceRecordSets", "http": { "method": "POST", "uri": "/2012-12-12/hostedzone/{HostedZoneId}/rrset/" }, "input": { "shape_name": "ChangeResourceRecordSetsRequest", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

\n

For more information, an example, and several ways to get the hosted zone ID for the LoadBalancer, see Creating Alias Resource Record Sets for Elastic Load Balancing in the Amazon Route 53 Developer Guide

.\n ", "required": true, "location": "uri" }, "ChangeBatch": { "shape_name": "ChangeBatch", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

Optional: Any comments you want to include about a change batch request.

\n " }, "Changes": { "shape_name": "Changes", "type": "list", "members": { "shape_name": "Change", "type": "structure", "members": { "Action": { "shape_name": "ChangeAction", "type": "string", "enum": [ "CREATE", "DELETE" ], "documentation": "\n

The action to perform.

\n

Valid values: CREATE | DELETE

\n ", "required": true }, "ResourceRecordSet": { "shape_name": "ResourceRecordSet", "type": "structure", "members": { "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The domain name of the current resource record set.

\n ", "required": true }, "Type": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\n

The type of the current resource record set.

\n ", "required": true }, "SetIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

Weighted, Regional, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.

\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", "type": "long", "min_length": 0, "max_length": 255, "documentation": "\n

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.

\n " }, "Region": { "shape_name": "ResourceRecordSetRegion", "type": "string", "min_length": 1, "max_length": 64, "enum": [ "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1" ], "documentation": "\n

Regional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.

\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", "type": "string", "enum": [ "PRIMARY", "SECONDARY" ], "documentation": "\n

Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.

\n

Valid values: PRIMARY | SECONDARY

\n " }, "TTL": { "shape_name": "TTL", "type": "long", "min_length": 0, "max_length": 2147483647, "documentation": "\n

The cache time to live for the current resource record set.

\n " }, "ResourceRecords": { "shape_name": "ResourceRecords", "type": "list", "members": { "shape_name": "ResourceRecord", "type": "structure", "members": { "Value": { "shape_name": "RData", "type": "string", "max_length": 4000, "documentation": "\n

The value of the Value element for the current resource record set.

\n ", "required": true } }, "member_order": [ "Value" ], "documentation": "\n

A complex type that contains the value of the Value element for the current resource record set.

\n ", "xmlname": "ResourceRecord" }, "min_length": 1, "documentation": "\n

A complex type that contains the resource records for the current resource record set.

\n " }, "AliasTarget": { "shape_name": "AliasTarget", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true }, "DNSName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

Alias resource record sets only: The external DNS name associated with the AWS Resource.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true }, "EvaluateTargetHealth": { "shape_name": "AliasHealthEnabled", "type": "boolean", "documentation": "\n

Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true } }, "member_order": [ "HostedZoneId", "DNSName", "EvaluateTargetHealth" ], "documentation": "\n

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

\n " }, "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

\n " } }, "member_order": [ "Name", "Type", "SetIdentifier", "Weight", "Region", "Failover", "TTL", "ResourceRecords", "AliasTarget", "HealthCheckId" ], "documentation": "\n

Information about the resource record set to create or delete.

\n ", "required": true } }, "member_order": [ "Action", "ResourceRecordSet" ], "documentation": "\n

A complex type that contains the information for each change in a change batch request.

\n ", "xmlname": "Change" }, "min_length": 1, "documentation": "\n

A complex type that contains one Change element for each resource record set that you want to create or delete.

\n ", "required": true } }, "member_order": [ "Comment", "Changes" ], "documentation": "\n

A complex type that contains an optional comment and the Changes element.

\n ", "required": true } }, "member_order": [ "HostedZoneId", "ChangeBatch" ], "documentation": "\n

A complex type that contains a change batch.

\n " }, "output": { "shape_name": "ChangeResourceRecordSetsResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\n

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

\n

Valid Values: PENDING | INSYNC

\n ", "required": true }, "SubmittedAt": { "shape_name": "TimeStamp", "type": "timestamp", "documentation": "\n

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

\n ", "required": true }, "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

A complex type that describes change information about changes made to your hosted zone.

\n

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\n

A complex type that contains information about changes made to your hosted zone.

\n

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\n

A complex type containing the response for the request.

\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The health check you are trying to get or delete does not exist.

\n " }, { "shape_name": "InvalidChangeBatch", "type": "structure", "members": { "messages": { "shape_name": "ErrorMessages", "type": "list", "members": { "shape_name": "ErrorMessage", "type": "string", "documentation": null, "xmlname": "Message" }, "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " }, { "shape_name": "PriorRequestNotComplete", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The request was rejected because Route 53 was still processing a prior request.

\n " } ], "documentation": "\n

Use this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2012-12-12/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML document with a ChangeResourceRecordSetsRequest element.

\n

Changes are a list of change items and are considered transactional. For more information on transactional changes, also known as change batches, see Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide.

\n Due to the nature of transactional changes, you cannot delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.\n

In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative Route 53 DNS servers. When the change is propagated to all hosts, the change returns a status of INSYNC.

\n

Note the following limitations on a ChangeResourceRecordSets request:

\n

- A request cannot contain more than 100 Change elements.

\n

- A request cannot contain more than 1000 ResourceRecord elements.

\n

The sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.

\n " }, "CreateHealthCheck": { "name": "CreateHealthCheck", "http": { "method": "POST", "uri": "/2012-12-12/healthcheck", "response_code": 201 }, "input": { "shape_name": "CreateHealthCheckRequest", "type": "structure", "members": { "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.

\n

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "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])$", "documentation": "\n

IP Address of the instance being checked.

\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified.

\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "TCP" ], "documentation": "\n

The type of health check to be performed. Currently supported protocols are TCP and HTTP.

\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\n

Path to ping on the instance to check the health. Required only for HTTP health checks, HTTP request is issued to the instance on the given port and path.

\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\n

Fully qualified domain name of the instance to be health checked.

\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName" ], "documentation": "\n

A complex type that contains health check configuration.

\n ", "required": true } }, "member_order": [ "CallerReference", "HealthCheckConfig" ], "documentation": "\n

>A complex type that contains information about the request to create a health check.

\n " }, "output": { "shape_name": "CreateHealthCheckResponse", "type": "structure", "members": { "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Id": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

The ID of the specified health check.

\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

A unique string that identifies the request to create the health check.

\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "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])$", "documentation": "\n

IP Address of the instance being checked.

\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified.

\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "TCP" ], "documentation": "\n

The type of health check to be performed. Currently supported protocols are TCP and HTTP.

\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\n

Path to ping on the instance to check the health. Required only for HTTP health checks, HTTP request is issued to the instance on the given port and path.

\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\n

Fully qualified domain name of the instance to be health checked.

\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName" ], "documentation": "\n

A complex type that contains the health check configuration.

\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\n

A complex type that contains identifying information about the health check.

\n ", "required": true }, "Location": { "shape_name": "ResourceURI", "type": "string", "max_length": 1024, "documentation": "\n

The unique URL representing the new health check.

\n ", "required": true, "location": "header", "location_name": "Location" } }, "member_order": [ "HealthCheck", "Location" ], "documentation": "\n

A complex type containing the response information for the new health check.

\n " }, "errors": [ { "shape_name": "TooManyHealthChecks", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "HealthCheckAlreadyExists", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The health check you are trying to create already exists. Route 53 returns this error when a health check has already been created with the specified CallerReference.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

This action creates a new health check.

\n

To create a new health check, send a POST request to the 2012-12-12/healthcheck resource. The request body must include an XML document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element that contains metadata about the health check.

\n " }, "CreateHostedZone": { "name": "CreateHostedZone", "http": { "method": "POST", "uri": "/2012-12-12/hostedzone", "response_code": 201 }, "input": { "shape_name": "CreateHostedZoneRequest", "type": "structure", "members": { "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

\n ", "required": true }, "CallerReference": { "shape_name": "Nonce", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.

\n

Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

\n ", "required": true }, "HostedZoneConfig": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

\n " } }, "member_order": [ "Comment" ], "documentation": "\n

A complex type that contains an optional comment about your hosted zone.

\n " } }, "member_order": [ "Name", "CallerReference", "HostedZoneConfig" ], "documentation": "\n

A complex type that contains information about the request to create a hosted zone.

\n " }, "output": { "shape_name": "CreateHostedZoneResponse", "type": "structure", "members": { "HostedZone": { "shape_name": "HostedZone", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the specified hosted zone.

\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

\n ", "required": true }, "CallerReference": { "shape_name": "Nonce", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

A unique string that identifies the request to create the hosted zone.

\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

\n " } }, "member_order": [ "Comment" ], "documentation": "\n

A complex type that contains the Comment element.

\n " }, "ResourceRecordSetCount": { "shape_name": "HostedZoneRRSetCount", "type": "long", "documentation": "\n

Total number of resource record sets in the hosted zone.

\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\n

A complex type that contains identifying information about the hosted zone.

\n ", "required": true }, "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\n

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

\n

Valid Values: PENDING | INSYNC

\n ", "required": true }, "SubmittedAt": { "shape_name": "TimeStamp", "type": "timestamp", "documentation": "\n

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

\n ", "required": true }, "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

A complex type that describes change information about changes made to your hosted zone.

\n

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\n

A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.

\n ", "required": true }, "DelegationSet": { "shape_name": "DelegationSet", "type": "structure", "members": { "NameServers": { "shape_name": "DelegationSetNameServers", "type": "list", "members": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": null, "xmlname": "NameServer" }, "min_length": 1, "documentation": "\n

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

\n ", "required": true } }, "member_order": [ "NameServers" ], "documentation": "\n

A complex type that contains name server information.

\n ", "required": true }, "Location": { "shape_name": "ResourceURI", "type": "string", "max_length": 1024, "documentation": "\n

The unique URL representing the new hosted zone.

\n ", "required": true, "location": "header", "location_name": "Location" } }, "member_order": [ "HostedZone", "ChangeInfo", "DelegationSet", "Location" ], "documentation": "\n

A complex type containing the response information for the new hosted zone.

\n " }, "errors": [ { "shape_name": "InvalidDomainName", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

This error indicates that the specified domain name is not valid.

\n " }, { "shape_name": "HostedZoneAlreadyExists", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The hosted zone you are trying to create already exists. Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

\n " }, { "shape_name": "TooManyHostedZones", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " }, { "shape_name": "DelegationSetNotAvailable", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Route 53 generates this error, you can request an increase to the limit on the Contact Us page.

\n " } ], "documentation": "\n

This action creates a new hosted zone.

\n

To create a new hosted zone, send a POST request to the 2012-12-12/hostedzone resource. The request body must include an XML document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element that contains metadata about the hosted zone.

\n

Route 53 automatically creates a default SOA record and four NS records for the zone. The NS records in the hosted zone are the name servers you give your registrar to delegate your domain to. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

\n

When you create a zone, its initial status is PENDING. This means that it is not yet available on all DNS servers. The status of the zone changes to INSYNC when the NS and SOA records are available on all Route 53 DNS servers.

\n " }, "DeleteHealthCheck": { "name": "DeleteHealthCheck", "http": { "method": "DELETE", "uri": "/2012-12-12/healthcheck/{HealthCheckId}" }, "input": { "shape_name": "DeleteHealthCheckRequest", "type": "structure", "members": { "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

The ID of the health check to delete.

\n ", "required": true, "location": "uri" } }, "member_order": [ "HealthCheckId" ], "documentation": "\n

A complex type containing the request information for delete health check.

\n " }, "output": { "shape_name": "DeleteHealthCheckResponse", "type": "structure", "members": {}, "documentation": "\n

Empty response for the request.

\n " }, "errors": [ { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The health check you are trying to get or delete does not exist.

\n " }, { "shape_name": "HealthCheckInUse", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

This action deletes a health check. To delete a health check, send a DELETE request to the 2012-12-12/healthcheck/health check ID resource.

\n You can delete a health check only if there are no resource record sets associated with this health check. If resource record sets are associated with this health check, you must disassociate them before you can delete your health check. If you try to delete a health check that is associated with resource record sets, Route 53 will deny your request with a HealthCheckInUse error. For information about disassociating the records from your health check, see ChangeResourceRecordSets.\n " }, "DeleteHostedZone": { "name": "DeleteHostedZone", "http": { "method": "DELETE", "uri": "/2012-12-12/hostedzone/{Id}" }, "input": { "shape_name": "DeleteHostedZoneRequest", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the request. Include this ID in a call to GetChange to track when the change has propagated to all Route 53 DNS servers.

\n ", "required": true, "location": "uri" } }, "member_order": [ "Id" ], "documentation": "\n

A complex type containing the response information for the delete request.

\n " }, "output": { "shape_name": "DeleteHostedZoneResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\n

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

\n

Valid Values: PENDING | INSYNC

\n ", "required": true }, "SubmittedAt": { "shape_name": "TimeStamp", "type": "timestamp", "documentation": "\n

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

\n ", "required": true }, "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

A complex type that describes change information about changes made to your hosted zone.

\n

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\n

A complex type that contains the ID, the status, and the date and time of your delete request.

\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\n

A complex type containing the response information for the request.

\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "HostedZoneNotEmpty", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.

\n " }, { "shape_name": "PriorRequestNotComplete", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n

The request was rejected because Route 53 was still processing a prior request.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

This action deletes a hosted zone. To delete a hosted zone, send a DELETE request to the 2012-12-12/hostedzone/hosted zone ID resource.

\n

For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide.

\n You can delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If your hosted zone contains other resource record sets, you must delete them before you can delete your hosted zone. If you try to delete a hosted zone that contains other resource record sets, Route 53 will deny your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.\n " }, "GetChange": { "name": "GetChange", "http": { "method": "GET", "uri": "/2012-12-12/change/{Id}" }, "input": { "shape_name": "GetChangeRequest", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

\n ", "required": true, "location": "uri" } }, "member_order": [ "Id" ], "documentation": "\n

The input for a GetChange request.

\n " }, "output": { "shape_name": "GetChangeResponse", "type": "structure", "members": { "ChangeInfo": { "shape_name": "ChangeInfo", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

\n ", "required": true }, "Status": { "shape_name": "ChangeStatus", "type": "string", "enum": [ "PENDING", "INSYNC" ], "documentation": "\n

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

\n

Valid Values: PENDING | INSYNC

\n ", "required": true }, "SubmittedAt": { "shape_name": "TimeStamp", "type": "timestamp", "documentation": "\n

The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.

\n ", "required": true }, "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

A complex type that describes change information about changes made to your hosted zone.

\n

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

\n " } }, "member_order": [ "Id", "Status", "SubmittedAt", "Comment" ], "documentation": "\n

A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.

\n ", "required": true } }, "member_order": [ "ChangeInfo" ], "documentation": "\n

A complex type that contains the ChangeInfo element.

\n " }, "errors": [ { "shape_name": "NoSuchChange", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

This action returns the current status of a change batch request. The status is one of the following values:

\n

- PENDING indicates that the changes in this request have not replicated to all Route 53 DNS servers. This is the initial status of all change batch requests.

\n

- INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.

\n " }, "GetHealthCheck": { "name": "GetHealthCheck", "http": { "method": "GET", "uri": "/2012-12-12/healthcheck/{HealthCheckId}" }, "input": { "shape_name": "GetHealthCheckRequest", "type": "structure", "members": { "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

The ID of the health check to retrieve.

\n ", "required": true, "location": "uri" } }, "member_order": [ "HealthCheckId" ], "documentation": "\n

A complex type that contains information about the request to get a health check.

\n " }, "output": { "shape_name": "GetHealthCheckResponse", "type": "structure", "members": { "HealthCheck": { "shape_name": "HealthCheck", "type": "structure", "members": { "Id": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

The ID of the specified health check.

\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

A unique string that identifies the request to create the health check.

\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "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])$", "documentation": "\n

IP Address of the instance being checked.

\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified.

\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "TCP" ], "documentation": "\n

The type of health check to be performed. Currently supported protocols are TCP and HTTP.

\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\n

Path to ping on the instance to check the health. Required only for HTTP health checks, HTTP request is issued to the instance on the given port and path.

\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\n

Fully qualified domain name of the instance to be health checked.

\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName" ], "documentation": "\n

A complex type that contains the health check configuration.

\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\n

A complex type that contains the information about the specified health check.

\n ", "required": true } }, "member_order": [ "HealthCheck" ], "documentation": "\n

A complex type containing information about the specified health check.

\n " }, "errors": [ { "shape_name": "NoSuchHealthCheck", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

The health check you are trying to get or delete does not exist.

\n " }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

To retrieve the health check, send a GET request to the 2012-12-12/healthcheck/health check ID resource.

\n " }, "GetHostedZone": { "name": "GetHostedZone", "http": { "method": "GET", "uri": "/2012-12-12/hostedzone/{Id}" }, "input": { "shape_name": "GetHostedZoneRequest", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

\n ", "required": true, "location": "uri" } }, "member_order": [ "Id" ], "documentation": "\n

The input for a GetHostedZone request.

\n " }, "output": { "shape_name": "GetHostedZoneResponse", "type": "structure", "members": { "HostedZone": { "shape_name": "HostedZone", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the specified hosted zone.

\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

\n ", "required": true }, "CallerReference": { "shape_name": "Nonce", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

A unique string that identifies the request to create the hosted zone.

\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

\n " } }, "member_order": [ "Comment" ], "documentation": "\n

A complex type that contains the Comment element.

\n " }, "ResourceRecordSetCount": { "shape_name": "HostedZoneRRSetCount", "type": "long", "documentation": "\n

Total number of resource record sets in the hosted zone.

\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\n

A complex type that contains the information about the specified hosted zone.

\n ", "required": true }, "DelegationSet": { "shape_name": "DelegationSet", "type": "structure", "members": { "NameServers": { "shape_name": "DelegationSetNameServers", "type": "list", "members": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": null, "xmlname": "NameServer" }, "min_length": 1, "documentation": "\n

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

\n ", "required": true } }, "member_order": [ "NameServers" ], "documentation": "\n

A complex type that contains information about the name servers for the specified hosted zone.

\n ", "required": true } }, "member_order": [ "HostedZone", "DelegationSet" ], "documentation": "\n

A complex type containing information about the specified hosted zone.

\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

To retrieve the delegation set for a hosted zone, send a GET request to the 2012-12-12/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.

\n " }, "ListHealthChecks": { "name": "ListHealthChecks", "http": { "method": "GET", "uri": "/2012-12-12/healthcheck?marker={Marker}&maxitems={MaxItems}" }, "input": { "shape_name": "ListHealthChecksRequest", "type": "structure", "members": { "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

\n ", "location": "uri" }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

Specify the maximum number of health checks to return per page of results.

\n ", "location": "uri" } }, "member_order": [ "Marker", "MaxItems" ], "documentation": "\n

To retrieve a list of your health checks, send a GET request to the 2012-12-12/healthcheck resource. The response to this request includes a HealthChecks element with zero or more HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

\n Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100.\n " }, "output": { "shape_name": "ListHealthChecksResponse", "type": "structure", "members": { "HealthChecks": { "shape_name": "HealthChecks", "type": "list", "members": { "shape_name": "HealthCheck", "type": "structure", "members": { "Id": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

The ID of the specified health check.

\n ", "required": true }, "CallerReference": { "shape_name": "HealthCheckNonce", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

A unique string that identifies the request to create the health check.

\n ", "required": true }, "HealthCheckConfig": { "shape_name": "HealthCheckConfig", "type": "structure", "members": { "IPAddress": { "shape_name": "IPAddress", "type": "string", "max_length": 15, "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])$", "documentation": "\n

IP Address of the instance being checked.

\n ", "required": true }, "Port": { "shape_name": "Port", "type": "integer", "min_length": 1, "max_length": 65535, "documentation": "\n

Port on which connection will be opened to the instance to health check. For HTTP this defaults to 80 if the port is not specified.

\n " }, "Type": { "shape_name": "HealthCheckType", "type": "string", "enum": [ "HTTP", "TCP" ], "documentation": "\n

The type of health check to be performed. Currently supported protocols are TCP and HTTP.

\n ", "required": true }, "ResourcePath": { "shape_name": "ResourcePath", "type": "string", "max_length": 255, "documentation": "\n

Path to ping on the instance to check the health. Required only for HTTP health checks, HTTP request is issued to the instance on the given port and path.

\n " }, "FullyQualifiedDomainName": { "shape_name": "FullyQualifiedDomainName", "type": "string", "max_length": 255, "documentation": "\n

Fully qualified domain name of the instance to be health checked.

\n " } }, "member_order": [ "IPAddress", "Port", "Type", "ResourcePath", "FullyQualifiedDomainName" ], "documentation": "\n

A complex type that contains the health check configuration.

\n ", "required": true } }, "member_order": [ "Id", "CallerReference", "HealthCheckConfig" ], "documentation": "\n

A complex type that contains identifying information about the health check.

\n ", "xmlname": "HealthCheck" }, "documentation": "\n

A complex type that contains information about the health checks associated with the current AWS account.

\n ", "required": true }, "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

\n ", "required": true }, "IsTruncated": { "shape_name": "PageTruncated", "type": "boolean", "documentation": "\n

A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

\n

Valid Values: true | false

\n ", "required": true }, "NextMarker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.

\n " }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

\n ", "required": true } }, "member_order": [ "HealthChecks", "Marker", "IsTruncated", "NextMarker", "MaxItems" ], "documentation": "\n

A complex type that contains the response for the request.

\n " }, "errors": [ { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

To retrieve a list of your health checks, send a GET request to the 2012-12-12/healthcheck resource. The response to this request includes a HealthChecks element with zero, one, or multiple HealthCheck child elements. By default, the list of health checks is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the health check that the list begins with.

\n Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.\n " }, "ListHostedZones": { "name": "ListHostedZones", "http": { "method": "GET", "uri": "/2012-12-12/hostedzone?marker={Marker}&maxitems={MaxItems}" }, "input": { "shape_name": "ListHostedZonesRequest", "type": "structure", "members": { "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

\n ", "location": "uri" }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

Specify the maximum number of hosted zones to return per page of results.

\n ", "location": "uri" } }, "member_order": [ "Marker", "MaxItems" ], "documentation": "\n

To retrieve a list of your hosted zones, send a GET request to the 2012-12-12/hostedzone resource. The response to this request includes a HostedZones element with zero or more HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with. For more information about listing hosted zones, see Listing the Hosted Zones for an AWS Account in the Amazon Route 53 Developer Guide.

\n Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100.\n " }, "output": { "shape_name": "ListHostedZonesResponse", "type": "structure", "members": { "HostedZones": { "shape_name": "HostedZones", "type": "list", "members": { "shape_name": "HostedZone", "type": "structure", "members": { "Id": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the specified hosted zone.

\n ", "required": true }, "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

\n

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

\n ", "required": true }, "CallerReference": { "shape_name": "Nonce", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

A unique string that identifies the request to create the hosted zone.

\n ", "required": true }, "Config": { "shape_name": "HostedZoneConfig", "type": "structure", "members": { "Comment": { "shape_name": "ResourceDescription", "type": "string", "max_length": 256, "documentation": "\n

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

\n " } }, "member_order": [ "Comment" ], "documentation": "\n

A complex type that contains the Comment element.

\n " }, "ResourceRecordSetCount": { "shape_name": "HostedZoneRRSetCount", "type": "long", "documentation": "\n

Total number of resource record sets in the hosted zone.

\n " } }, "member_order": [ "Id", "Name", "CallerReference", "Config", "ResourceRecordSetCount" ], "documentation": "\n

A complex type that contain information about the specified hosted zone.

\n ", "xmlname": "HostedZone" }, "documentation": "\n

A complex type that contains information about the hosted zones associated with the current AWS account.

\n ", "required": true }, "Marker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

\n ", "required": true }, "IsTruncated": { "shape_name": "PageTruncated", "type": "boolean", "documentation": "\n

A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

\n

Valid Values: true | false

\n ", "required": true }, "NextMarker": { "shape_name": "PageMarker", "type": "string", "max_length": 64, "documentation": "\n

Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.

\n " }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

\n ", "required": true } }, "member_order": [ "HostedZones", "Marker", "IsTruncated", "NextMarker", "MaxItems" ], "documentation": "\n

A complex type that contains the response for the request.

\n " }, "errors": [ { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

To retrieve a list of your hosted zones, send a GET request to the 2012-12-12/hostedzone resource. The response to this request includes a HostedZones element with zero, one, or multiple HostedZone child elements. By default, the list of hosted zones is displayed on a single page. You can control the length of the page that is displayed by using the MaxItems parameter. You can use the Marker parameter to control the hosted zone that the list begins with.

\n Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Amazon Route 53 returns only the first 100.\n " }, "ListResourceRecordSets": { "name": "ListResourceRecordSets", "http": { "method": "GET", "uri": "/2012-12-12/hostedzone/{HostedZoneId}/rrset?type={StartRecordType}&name={StartRecordName}&identifier={StartRecordIdentifier}&maxitems={MaxItems}" }, "input": { "shape_name": "ListResourceRecordSetsRequest", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

The ID of the hosted zone that contains the resource record sets that you want to get.

\n ", "required": true, "location": "uri" }, "StartRecordName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

\n ", "location": "uri" }, "StartRecordType": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\n

The DNS type at which to begin the listing of resource record sets.

\n

Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

\n

Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

\n

Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

\n

Values for Alias Resource Record Sets: A | AAAA

\n

Constraint: Specifying type without specifying name returns an InvalidInput error.

\n ", "location": "uri" }, "StartRecordIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

\n ", "location": "uri" }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

The maximum number of records you want in the response body.

\n ", "location": "uri" } }, "member_order": [ "HostedZoneId", "StartRecordName", "StartRecordType", "StartRecordIdentifier", "MaxItems" ], "documentation": "\n

The input for a ListResourceRecordSets request.

\n " }, "output": { "shape_name": "ListResourceRecordSetsResponse", "type": "structure", "members": { "ResourceRecordSets": { "shape_name": "ResourceRecordSets", "type": "list", "members": { "shape_name": "ResourceRecordSet", "type": "structure", "members": { "Name": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

The domain name of the current resource record set.

\n ", "required": true }, "Type": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\n

The type of the current resource record set.

\n ", "required": true }, "SetIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

Weighted, Regional, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.

\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", "type": "long", "min_length": 0, "max_length": 255, "documentation": "\n

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.

\n " }, "Region": { "shape_name": "ResourceRecordSetRegion", "type": "string", "min_length": 1, "max_length": 64, "enum": [ "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1" ], "documentation": "\n

Regional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.

\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", "type": "string", "enum": [ "PRIMARY", "SECONDARY" ], "documentation": "\n

Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.

\n

Valid values: PRIMARY | SECONDARY

\n " }, "TTL": { "shape_name": "TTL", "type": "long", "min_length": 0, "max_length": 2147483647, "documentation": "\n

The cache time to live for the current resource record set.

\n " }, "ResourceRecords": { "shape_name": "ResourceRecords", "type": "list", "members": { "shape_name": "ResourceRecord", "type": "structure", "members": { "Value": { "shape_name": "RData", "type": "string", "max_length": 4000, "documentation": "\n

The value of the Value element for the current resource record set.

\n ", "required": true } }, "member_order": [ "Value" ], "documentation": "\n

A complex type that contains the value of the Value element for the current resource record set.

\n ", "xmlname": "ResourceRecord" }, "min_length": 1, "documentation": "\n

A complex type that contains the resource records for the current resource record set.

\n " }, "AliasTarget": { "shape_name": "AliasTarget", "type": "structure", "members": { "HostedZoneId": { "shape_name": "ResourceId", "type": "string", "max_length": 32, "documentation": "\n

Alias resource record sets only: The value of the hosted zone ID for the AWS resource.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true }, "DNSName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

Alias resource record sets only: The external DNS name associated with the AWS Resource.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true }, "EvaluateTargetHealth": { "shape_name": "AliasHealthEnabled", "type": "boolean", "documentation": "\n

Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.

\n

For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide

.\n ", "required": true } }, "member_order": [ "HostedZoneId", "DNSName", "EvaluateTargetHealth" ], "documentation": "\n

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

\n " }, "HealthCheckId": { "shape_name": "HealthCheckId", "type": "string", "max_length": 64, "documentation": "\n

Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

\n " } }, "member_order": [ "Name", "Type", "SetIdentifier", "Weight", "Region", "Failover", "TTL", "ResourceRecords", "AliasTarget", "HealthCheckId" ], "documentation": "\n

A complex type that contains information about the current resource record set.

\n ", "xmlname": "ResourceRecordSet" }, "documentation": "\n

A complex type that contains information about the resource record sets that are returned by the request.

\n ", "required": true }, "IsTruncated": { "shape_name": "PageTruncated", "type": "boolean", "documentation": "\n

A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.

\n

Valid Values: true | false

\n ", "required": true }, "NextRecordName": { "shape_name": "DNSName", "type": "string", "max_length": 1024, "documentation": "\n

If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

\n " }, "NextRecordType": { "shape_name": "RRType", "type": "string", "enum": [ "SOA", "A", "TXT", "NS", "CNAME", "MX", "PTR", "SRV", "SPF", "AAAA" ], "documentation": "\n

If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

\n " }, "NextRecordIdentifier": { "shape_name": "ResourceRecordSetIdentifier", "type": "string", "min_length": 1, "max_length": 128, "documentation": "\n

Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

\n " }, "MaxItems": { "shape_name": "PageMaxItems", "type": "string", "documentation": "\n

The maximum number of records you requested. The maximum value of MaxItems is 100.

\n ", "required": true } }, "member_order": [ "ResourceRecordSets", "IsTruncated", "NextRecordName", "NextRecordType", "NextRecordIdentifier", "MaxItems" ], "documentation": "\n

A complex type that contains information about the resource record sets that are returned by the request and information about the response.

\n " }, "errors": [ { "shape_name": "NoSuchHostedZone", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null }, { "shape_name": "InvalidInput", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Descriptive message for the error response.

\n " } }, "documentation": "\n

Some value specified in the request is invalid or the XML document is malformed.

\n " } ], "documentation": "\n

Imagine all the resource record sets in a zone listed out in front of you.\n Imagine them sorted lexicographically first by DNS name (with the labels\n reversed, like \"com.amazon.www\" for example), and secondarily,\n lexicographically by record type. This operation retrieves at most MaxItems\n resource record sets from this list, in order, starting at a position\n specified by the Name and Type arguments:

\n \n

Use ListResourceRecordSets to retrieve a single known record set by\n specifying the record set's name and type, and setting MaxItems = 1

\n

To retrieve all the records in a HostedZone, first pause any processes\n making calls to ChangeResourceRecordSets. Initially call ListResourceRecordSets\n without a Name and Type to get the first page of record sets. For subsequent\n calls, set Name and Type to the NextName and NextType values returned by the\n previous response.\n

\n

In the presence of concurrent ChangeResourceRecordSets calls, there is no\n consistency of results across calls to ListResourceRecordSets. The only way\n to get a consistent multi-page snapshot of all RRSETs in a zone is to stop\n making changes while pagination is in progress.

\n

However, the results from ListResourceRecordSets are consistent within a\n page. If MakeChange calls are taking place concurrently, the result of each\n one will either be completely visible in your results or not at all. You will\n not see partial changes, or changes that do not ultimately succeed. (This\n follows from the fact that MakeChange is atomic)\n

\n

The results from ListResourceRecordSets are strongly consistent with\n ChangeResourceRecordSets. To be precise, if a single process makes a call to\n ChangeResourceRecordSets and receives a successful response, the effects of that\n change will be visible in a subsequent call to ListResourceRecordSets by\n that process.

\n " } }, "metadata": { "regions": { "us-east-1": "https://route53.amazonaws.com/" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/s3.json0000644000175000017500000065120412254746566017500 0ustar takakitakaki{ "api_version": "2006-03-01", "type": "rest-xml", "signature_version": "s3", "timestamp_format": "rfc822", "checksum_format": "md5", "service_full_name": "Amazon Simple Storage Service", "service_abbreviation": "Amazon S3", "global_endpoint": "s3.amazonaws.com", "endpoint_prefix": "s3", "xmlnamespace": "http://s3.amazonaws.com/doc/2006-03-01/", "operations": { "AbortMultipartUpload": { "name": "AbortMultipartUpload", "http": { "method": "DELETE", "uri": "/{Bucket}/{Key}?uploadId={UploadId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "UploadId": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [ { "shape_name": "NoSuchUpload", "type": "structure", "documentation": "The specified multipart upload does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadAbort.html", "documentation": "

Aborts a multipart upload.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

" }, "CompleteMultipartUpload": { "name": "CompleteMultipartUpload", "http": { "method": "POST", "uri": "/{Bucket}/{Key}?uploadId={UploadId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "MultipartUpload": { "type": "structure", "payload": true, "xmlname": "CompleteMultipartUpload", "members": { "Parts": { "type": "list", "xmlname": "Part", "members": { "type": "structure", "members": { "ETag": { "type": "string", "documentation": "Entity tag returned when the part was uploaded." }, "PartNumber": { "type": "integer", "documentation": "Part number that identifies the part." } } }, "flattened": true } } }, "UploadId": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "CompleteMultipartUploadOutput", "type": "structure", "members": { "Bucket": { "type": "string" }, "ETag": { "type": "string", "documentation": "Entity tag of the object." }, "Expiration": { "type": "timestamp", "location": "header", "location_name": "x-amz-expiration", "documentation": "If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." }, "Key": { "type": "string" }, "Location": { "type": "string" }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "VersionId": { "type": "string", "location": "header", "location_name": "x-amz-version-id", "documentation": "Version of the object." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadComplete.html", "documentation": "Completes a multipart upload by assembling previously uploaded parts." }, "CopyObject": { "name": "CopyObject", "alias": "PutObjectCopy", "http": { "method": "PUT", "uri": "/{Bucket}/{Key}" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the object." }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "CacheControl": { "type": "string", "location": "header", "location_name": "Cache-Control", "documentation": "Specifies caching behavior along the request/reply chain." }, "ContentDisposition": { "type": "string", "location": "header", "location_name": "Content-Disposition", "documentation": "Specifies presentational information for the object." }, "ContentEncoding": { "type": "string", "location": "header", "location_name": "Content-Encoding", "documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." }, "ContentLanguage": { "type": "string", "location": "header", "location_name": "Content-Language", "documentation": "The language the content is in." }, "ContentType": { "type": "string", "location": "header", "location_name": "Content-Type", "documentation": "A standard MIME type describing the format of the object data." }, "CopySource": { "type": "string", "required": true, "location": "header", "location_name": "x-amz-copy-source", "documentation": "The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.", "pattern": "\\/.+\\/.+" }, "CopySourceIfMatch": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-match", "documentation": "Copies the object if its entity tag (ETag) matches the specified tag." }, "CopySourceIfModifiedSince": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-modified-since", "documentation": "Copies the object if it has been modified since the specified time." }, "CopySourceIfNoneMatch": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-none-match", "documentation": "Copies the object if its entity tag (ETag) is different than the specified ETag." }, "CopySourceIfUnmodifiedSince": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-unmodified-since", "documentation": "Copies the object if it hasn't been modified since the specified time." }, "Expires": { "type": "timestamp", "location": "header", "location_name": "Expires", "documentation": "The date and time at which the object is no longer cacheable." }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to read the object data and its metadata." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the object ACL." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable object." }, "Key": { "type": "string", "required": true, "location": "uri" }, "Metadata": { "type": "map", "location": "header", "location_name": "x-amz-meta-", "members": { "type": "string", "documentation": "The metadata value." }, "documentation": "A map of metadata to store with the object in S3.", "keys": { "type": "string", "documentation": "The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers." } }, "MetadataDirective": { "type": "string", "location": "header", "location_name": "x-amz-metadata-directive", "enum": [ "COPY", "REPLACE" ], "documentation": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "StorageClass": { "type": "string", "location": "header", "location_name": "x-amz-storage-class", "enum": [ "STANDARD", "REDUCED_REDUNDANCY" ], "documentation": "The type of storage to use for the object. Defaults to 'STANDARD'." }, "WebsiteRedirectLocation": { "type": "string", "location": "header", "location_name": "x-amz-website-redirect-location", "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", "no_paramfile": true } } }, "output": { "shape_name": "CopyObjectOutput", "type": "structure", "members": { "CopyObjectResult": { "type": "structure", "payload": true, "members": { "ETag": { "type": "string" }, "LastModified": { "type": "string" } } }, "CopySourceVersionId": { "type": "string", "location": "header", "location_name": "x-amz-copy-source-version-id" }, "Expiration": { "type": "string", "location": "header", "location_name": "x-amz-expiration", "documentation": "If the object expiration is configured, the response includes this header." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." } } }, "errors": [ { "shape_name": "ObjectNotInActiveTierError", "type": "structure", "documentation": "The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html", "documentation": "Creates a copy of an object that is already stored in Amazon S3." }, "CreateBucket": { "name": "CreateBucket", "alias": "PutBucket", "http": { "method": "PUT", "uri": "/{Bucket}" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the bucket." }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "CreateBucketConfiguration": { "type": "structure", "payload": true, "members": { "LocationConstraint": { "type": "string", "enum": [ "EU", "eu-west-1", "us-west-1", "us-west-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1", "" ], "documentation": "Specifies the region where the bucket will be created." } } }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to list the objects in the bucket." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the bucket ACL." }, "GrantWrite": { "type": "string", "location": "header", "location_name": "x-amz-grant-write", "documentation": "Allows grantee to create, overwrite, and delete any object in the bucket." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable bucket." } } }, "output": { "shape_name": "CreateBucketOutput", "type": "structure", "members": { "Location": { "type": "string", "location": "header", "location_name": "Location" } } }, "errors": [ { "shape_name": "BucketAlreadyExists", "type": "structure", "documentation": "The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html", "documentation": "Creates a new bucket." }, "CreateMultipartUpload": { "name": "CreateMultipartUpload", "alias": "InitiateMultipartUpload", "http": { "method": "POST", "uri": "/{Bucket}/{Key}?uploads" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the object." }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "CacheControl": { "type": "string", "location": "header", "location_name": "Cache-Control", "documentation": "Specifies caching behavior along the request/reply chain." }, "ContentDisposition": { "type": "string", "location": "header", "location_name": "Content-Disposition", "documentation": "Specifies presentational information for the object." }, "ContentEncoding": { "type": "string", "location": "header", "location_name": "Content-Encoding", "documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." }, "ContentLanguage": { "type": "string", "location": "header", "location_name": "Content-Language", "documentation": "The language the content is in." }, "ContentType": { "type": "string", "location": "header", "location_name": "Content-Type", "documentation": "A standard MIME type describing the format of the object data." }, "Expires": { "type": "timestamp", "location": "header", "location_name": "Expires", "documentation": "The date and time at which the object is no longer cacheable." }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to read the object data and its metadata." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the object ACL." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable object." }, "Key": { "type": "string", "required": true, "location": "uri" }, "Metadata": { "type": "map", "location": "header", "location_name": "x-amz-meta-", "members": { "type": "string", "documentation": "The metadata value." }, "documentation": "A map of metadata to store with the object in S3.", "keys": { "type": "string", "documentation": "The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers." } }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "StorageClass": { "type": "string", "location": "header", "location_name": "x-amz-storage-class", "enum": [ "STANDARD", "REDUCED_REDUNDANCY" ], "documentation": "The type of storage to use for the object. Defaults to 'STANDARD'." }, "WebsiteRedirectLocation": { "type": "string", "location": "header", "location_name": "x-amz-website-redirect-location", "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", "no_paramfile": true } } }, "output": { "shape_name": "CreateMultipartUploadOutput", "type": "structure", "members": { "Bucket": { "type": "string", "xmlname": "Bucket", "documentation": "Name of the bucket to which the multipart upload was initiated." }, "Key": { "type": "string", "documentation": "Object key for which the multipart upload was initiated." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "UploadId": { "type": "string", "documentation": "ID for the initiated multipart upload." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html", "documentation": "

Initiates a multipart upload and returns an upload ID.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

" }, "DeleteBucket": { "name": "DeleteBucket", "http": { "method": "DELETE", "uri": "/{Bucket}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETE.html", "documentation": "Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted." }, "DeleteBucketCors": { "name": "DeleteBucketCors", "http": { "method": "DELETE", "uri": "/{Bucket}?cors" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEcors.html", "documentation": "Deletes the cors configuration information set for the bucket." }, "DeleteBucketLifecycle": { "name": "DeleteBucketLifecycle", "http": { "method": "DELETE", "uri": "/{Bucket}?lifecycle" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html", "documentation": "Deletes the lifecycle configuration from the bucket." }, "DeleteBucketPolicy": { "name": "DeleteBucketPolicy", "http": { "method": "DELETE", "uri": "/{Bucket}?policy" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html", "documentation": "Deletes the policy from the bucket." }, "DeleteBucketTagging": { "name": "DeleteBucketTagging", "http": { "method": "DELETE", "uri": "/{Bucket}?tagging" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html", "documentation": "Deletes the tags from the bucket." }, "DeleteBucketWebsite": { "name": "DeleteBucketWebsite", "http": { "method": "DELETE", "uri": "/{Bucket}?website" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html", "documentation": "This operation removes the website configuration from the bucket." }, "DeleteObject": { "name": "DeleteObject", "http": { "method": "DELETE", "uri": "/{Bucket}/{Key}?versionId={VersionId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "MFA": { "type": "string", "location": "header", "location_name": "x-amz-mfa", "documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." }, "VersionId": { "type": "string", "location": "uri", "documentation": "VersionId used to reference a specific version of the object." } } }, "output": { "shape_name": "DeleteObjectOutput", "type": "structure", "members": { "DeleteMarker": { "type": "boolean", "location": "header", "location_name": "x-amz-delete-marker", "documentation": "Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker." }, "VersionId": { "type": "string", "location": "header", "location_name": "x-amz-version-id", "documentation": "Returns the version ID of the delete marker created as a result of the DELETE operation." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html", "documentation": "Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects." }, "DeleteObjects": { "name": "DeleteObjects", "alias": "DeleteMultipleObjects", "http": { "method": "POST", "uri": "/{Bucket}?delete" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Delete": { "type": "structure", "payload": true, "required": true, "members": { "Objects": { "type": "list", "required": true, "xmlname": "Object", "members": { "type": "structure", "members": { "Key": { "type": "string", "required": true, "documentation": "Key name of the object to delete." }, "VersionId": { "type": "string", "documentation": "VersionId for the specific version of the object to delete." } } }, "flattened": true }, "Quiet": { "type": "boolean", "documentation": "Element to enable quiet mode for the request. When you add this element, you must set its value to true." } } }, "MFA": { "type": "string", "location": "header", "location_name": "x-amz-mfa", "documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." } } }, "output": { "shape_name": "DeleteObjectsOutput", "type": "structure", "members": { "Deleted": { "type": "list", "members": { "type": "structure", "members": { "DeleteMarker": { "type": "boolean" }, "DeleteMarkerVersionId": { "type": "string" }, "Key": { "type": "string" }, "VersionId": { "type": "string" } } }, "flattened": true }, "Errors": { "type": "list", "xmlname": "Error", "members": { "type": "structure", "members": { "Code": { "type": "string" }, "Key": { "type": "string" }, "Message": { "type": "string" }, "VersionId": { "type": "string" } } }, "flattened": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/multiobjectdeleteapi.html", "documentation": "This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys." }, "GetBucketAcl": { "name": "GetBucketAcl", "http": { "method": "GET", "uri": "/{Bucket}?acl" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketAclOutput", "type": "structure", "members": { "Grants": { "type": "list", "xmlname": "AccessControlList", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string", "enum": [ "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP" ], "documentation": "Specifies the permission given to the grantee." } } }, "documentation": "A list of grants." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETacl.html", "documentation": "Gets the access control policy for the bucket." }, "GetBucketCors": { "name": "GetBucketCors", "http": { "method": "GET", "uri": "/{Bucket}?cors" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketCorsOutput", "type": "structure", "members": { "CORSRules": { "type": "list", "xmlname": "CORSRule", "members": { "type": "structure", "members": { "AllowedHeaders": { "type": "list", "xmlname": "AllowedHeader", "members": { "type": "string" }, "documentation": "Specifies which headers are allowed in a pre-flight OPTIONS request.", "flattened": true }, "AllowedMethods": { "type": "list", "xmlname": "AllowedMethod", "members": { "type": "string" }, "documentation": "Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.", "flattened": true }, "AllowedOrigins": { "type": "list", "xmlname": "AllowedOrigin", "members": { "type": "string" }, "documentation": "One or more origins you want customers to be able to access the bucket from.", "flattened": true }, "ExposeHeaders": { "type": "list", "xmlname": "ExposeHeader", "members": { "type": "string" }, "documentation": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).", "flattened": true }, "MaxAgeSeconds": { "type": "integer", "documentation": "The time in seconds that your browser is to cache the preflight response for the specified resource." } } }, "flattened": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETcors.html", "documentation": "Returns the cors configuration for the bucket." }, "GetBucketLifecycle": { "name": "GetBucketLifecycle", "http": { "method": "GET", "uri": "/{Bucket}?lifecycle" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketLifecycleOutput", "type": "structure", "members": { "Rules": { "type": "list", "xmlname": "Rule", "members": { "type": "structure", "members": { "Expiration": { "type": "structure", "members": { "Date": { "type": "timestamp", "documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.", "timestamp_format": "iso8601" }, "Days": { "type": "integer", "documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." } } }, "ID": { "type": "string", "documentation": "Unique identifier for the rule. The value cannot be longer than 255 characters." }, "Prefix": { "type": "string", "documentation": "Prefix identifying one or more objects to which the rule applies." }, "Status": { "type": "string", "enum": [ "Enabled", "Disabled" ], "documentation": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." }, "Transition": { "type": "structure", "members": { "Date": { "type": "timestamp", "documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.", "timestamp_format": "iso8601" }, "Days": { "type": "integer", "documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." } } } } }, "flattened": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html", "documentation": "Returns the lifecycle configuration information set on the bucket." }, "GetBucketLocation": { "name": "GetBucketLocation", "http": { "method": "GET", "uri": "/{Bucket}?location" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketLocationOutput", "type": "structure", "members": { "LocationConstraint": { "type": "string" } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlocation.html", "documentation": "Returns the region the bucket resides in." }, "GetBucketLogging": { "name": "GetBucketLogging", "http": { "method": "GET", "uri": "/{Bucket}?logging" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketLoggingOutput", "type": "structure", "members": { "LoggingEnabled": { "type": "structure", "members": { "TargetBucket": { "type": "string", "documentation": "Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key." }, "TargetGrants": { "type": "list", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string" } } } }, "TargetPrefix": { "type": "string", "documentation": "This element lets you specify a prefix for the keys that the log files will be stored under." } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETlogging.html", "documentation": "Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner." }, "GetBucketNotification": { "name": "GetBucketNotification", "http": { "method": "GET", "uri": "/{Bucket}?notification" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketNotificationOutput", "type": "structure", "members": { "TopicConfiguration": { "type": "structure", "members": { "Event": { "type": "string", "enum": [ "s3:ReducedRedundancyLostObject" ], "documentation": "Bucket event for which to send notifications." }, "Topic": { "type": "string", "documentation": "Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETnotification.html", "documentation": "Return the notification configuration of a bucket." }, "GetBucketPolicy": { "name": "GetBucketPolicy", "http": { "method": "GET", "uri": "/{Bucket}?policy" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketPolicyOutput", "type": "structure", "members": { "Policy": { "type": "string", "payload": true, "documentation": "The bucket policy as a JSON document." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETpolicy.html", "documentation": "Returns the policy of a specified bucket." }, "GetBucketRequestPayment": { "name": "GetBucketRequestPayment", "http": { "method": "GET", "uri": "/{Bucket}?requestPayment" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketRequestPaymentOutput", "type": "structure", "members": { "Payer": { "type": "string", "enum": [ "Requester", "BucketOwner" ], "documentation": "Specifies who pays for the download and request fees." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTrequestPaymentGET.html", "documentation": "Returns the request payment configuration of a bucket." }, "GetBucketTagging": { "name": "GetBucketTagging", "http": { "method": "GET", "uri": "/{Bucket}?tagging" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketTaggingOutput", "type": "structure", "members": { "TagSet": { "type": "list", "members": { "type": "structure", "xmlname": "Tag", "members": { "Key": { "type": "string", "documentation": "Name of the tag." }, "Value": { "type": "string", "documentation": "Value of the tag." } } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETtagging.html", "documentation": "Returns the tag set associated with the bucket." }, "GetBucketVersioning": { "name": "GetBucketVersioning", "http": { "method": "GET", "uri": "/{Bucket}?versioning" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketVersioningOutput", "type": "structure", "members": { "MfaDelete": { "type": "string", "enum": [ "Enabled", "Disabled" ], "documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned." }, "Status": { "type": "string", "enum": [ "Enabled", "Suspended" ], "documentation": "The versioning state of the bucket." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html", "documentation": "Returns the versioning state of a bucket." }, "GetBucketWebsite": { "name": "GetBucketWebsite", "http": { "method": "GET", "uri": "/{Bucket}?website" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetBucketWebsiteOutput", "type": "structure", "members": { "ErrorDocument": { "type": "structure", "members": { "Key": { "type": "string", "documentation": "The object key name to use when a 4XX class error occurs." } } }, "IndexDocument": { "type": "structure", "members": { "Suffix": { "type": "string", "documentation": "A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character." } } }, "RedirectAllRequestsTo": { "type": "structure", "members": { "HostName": { "type": "string", "documentation": "Name of the host where requests will be redirected." }, "Protocol": { "type": "string", "enum": [ "http", "https" ], "documentation": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." } } }, "RoutingRules": { "type": "list", "members": { "type": "structure", "xmlname": "RoutingRule", "members": { "Condition": { "type": "structure", "members": { "HttpErrorCodeReturnedEquals": { "type": "string", "documentation": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied." }, "KeyPrefixEquals": { "type": "string", "documentation": "The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied." } }, "documentation": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." }, "Redirect": { "type": "structure", "members": { "HostName": { "type": "string", "documentation": "The host name to use in the redirect request." }, "HttpRedirectCode": { "type": "string", "documentation": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." }, "Protocol": { "type": "string", "enum": [ "http", "https" ], "documentation": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." }, "ReplaceKeyPrefixWith": { "type": "string", "documentation": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided." }, "ReplaceKeyWith": { "type": "string", "documentation": "The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided." } }, "documentation": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return." } } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETwebsite.html", "documentation": "Returns the website configuration for a bucket." }, "GetObject": { "name": "GetObject", "http": { "method": "GET", "uri": "/{Bucket}/{Key}?versionId={VersionId}&response-content-type={ResponseContentType}&response-content-language={ResponseContentLanguage}&response-expires={ResponseExpires}&response-cache-control={ResponseCacheControl}&response-content-disposition={ResponseContentDisposition}&response-content-encoding={ResponseContentEncoding}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "IfMatch": { "type": "string", "location": "header", "location_name": "If-Match", "documentation": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." }, "IfModifiedSince": { "type": "timestamp", "location": "header", "location_name": "If-Modified-Since", "documentation": "Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." }, "IfNoneMatch": { "type": "string", "location": "header", "location_name": "If-None-Match", "documentation": "Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." }, "IfUnmodifiedSince": { "type": "timestamp", "location": "header", "location_name": "If-Unmodified-Since", "documentation": "Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." }, "Key": { "type": "string", "required": true, "location": "uri" }, "Range": { "type": "string", "location": "header", "location_name": "Range", "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." }, "ResponseCacheControl": { "type": "string", "location": "uri", "documentation": "Sets the Cache-Control header of the response." }, "ResponseContentDisposition": { "type": "string", "location": "uri", "documentation": "Sets the Content-Disposition header of the response" }, "ResponseContentEncoding": { "type": "string", "location": "uri", "documentation": "Sets the Content-Encoding header of the response." }, "ResponseContentLanguage": { "type": "string", "location": "uri", "documentation": "Sets the Content-Language header of the response." }, "ResponseContentType": { "type": "string", "location": "uri", "documentation": "Sets the Content-Type header of the response." }, "ResponseExpires": { "type": "timestamp", "location": "uri", "documentation": "Sets the Expires header of the response." }, "VersionId": { "type": "string", "location": "uri", "documentation": "VersionId used to reference a specific version of the object." } } }, "output": { "shape_name": "GetObjectOutput", "type": "structure", "members": { "AcceptRanges": { "type": "string", "location": "header", "location_name": "accept-ranges" }, "Body": { "type": "blob", "payload": true, "documentation": "Object data.", "streaming": true }, "CacheControl": { "type": "string", "location": "header", "location_name": "Cache-Control", "documentation": "Specifies caching behavior along the request/reply chain." }, "ContentDisposition": { "type": "string", "location": "header", "location_name": "Content-Disposition", "documentation": "Specifies presentational information for the object." }, "ContentEncoding": { "type": "string", "location": "header", "location_name": "Content-Encoding", "documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." }, "ContentLanguage": { "type": "string", "location": "header", "location_name": "Content-Language", "documentation": "The language the content is in." }, "ContentLength": { "type": "integer", "location": "header", "location_name": "Content-Length", "documentation": "Size of the body in bytes." }, "ContentType": { "type": "string", "location": "header", "location_name": "Content-Type", "documentation": "A standard MIME type describing the format of the object data." }, "DeleteMarker": { "type": "boolean", "location": "header", "location_name": "x-amz-delete-marker", "documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." }, "ETag": { "type": "string", "location": "header", "location_name": "ETag", "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" }, "Expiration": { "type": "string", "location": "header", "location_name": "x-amz-expiration", "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." }, "Expires": { "type": "timestamp", "location": "header", "location_name": "Expires", "documentation": "The date and time at which the object is no longer cacheable." }, "LastModified": { "type": "timestamp", "location": "header", "location_name": "Last-Modified", "documentation": "Last modified date of the object" }, "Metadata": { "type": "map", "location": "header", "location_name": "x-amz-meta-", "members": { "type": "string", "documentation": "The metadata value." }, "documentation": "A map of metadata to store with the object in S3.", "keys": { "type": "string", "documentation": "The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers." } }, "MissingMeta": { "type": "integer", "location": "header", "location_name": "x-amz-missing-meta", "documentation": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." }, "Restore": { "type": "string", "location": "header", "location_name": "x-amz-restore", "documentation": "Provides information about object restoration operation and expiration time of the restored object copy." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "VersionId": { "type": "string", "location": "header", "location_name": "x-amz-version-id", "documentation": "Version of the object." }, "WebsiteRedirectLocation": { "type": "string", "location": "header", "location_name": "x-amz-website-redirect-location", "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." } } }, "errors": [ { "shape_name": "NoSuchKey", "type": "structure", "documentation": "The specified key does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html", "documentation": "Retrieves objects from Amazon S3." }, "GetObjectAcl": { "name": "GetObjectAcl", "http": { "method": "GET", "uri": "/{Bucket}/{Key}?acl&versionId={VersionId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "VersionId": { "type": "string", "location": "uri", "documentation": "VersionId used to reference a specific version of the object." } } }, "output": { "shape_name": "GetObjectAclOutput", "type": "structure", "members": { "Grants": { "type": "list", "xmlname": "AccessControlList", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string", "enum": [ "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP" ], "documentation": "Specifies the permission given to the grantee." } } }, "documentation": "A list of grants." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } } } }, "errors": [ { "shape_name": "NoSuchKey", "type": "structure", "documentation": "The specified key does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGETacl.html", "documentation": "Returns the access control list (ACL) of an object." }, "GetObjectTorrent": { "name": "GetObjectTorrent", "http": { "method": "GET", "uri": "/{Bucket}/{Key}?torrent" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" } } }, "output": { "shape_name": "GetObjectTorrentOutput", "type": "structure", "members": { "Body": { "type": "blob", "payload": true, "streaming": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGETtorrent.html", "documentation": "Return torrent files from a bucket." }, "HeadBucket": { "name": "HeadBucket", "http": { "method": "HEAD", "uri": "/{Bucket}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [ { "shape_name": "NoSuchBucket", "type": "structure", "documentation": "The specified bucket does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketHEAD.html", "documentation": "This operation is useful to determine if a bucket exists and you have permission to access it." }, "HeadObject": { "name": "HeadObject", "http": { "method": "HEAD", "uri": "/{Bucket}/{Key}?versionId={VersionId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "IfMatch": { "type": "string", "location": "header", "location_name": "If-Match", "documentation": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed)." }, "IfModifiedSince": { "type": "timestamp", "location": "header", "location_name": "If-Modified-Since", "documentation": "Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified)." }, "IfNoneMatch": { "type": "string", "location": "header", "location_name": "If-None-Match", "documentation": "Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified)." }, "IfUnmodifiedSince": { "type": "timestamp", "location": "header", "location_name": "If-Unmodified-Since", "documentation": "Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed)." }, "Key": { "type": "string", "required": true, "location": "uri" }, "Range": { "type": "string", "location": "header", "location_name": "Range", "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35." }, "VersionId": { "type": "string", "location": "uri", "documentation": "VersionId used to reference a specific version of the object." } } }, "output": { "shape_name": "HeadObjectOutput", "type": "structure", "members": { "AcceptRanges": { "type": "string", "location": "header", "location_name": "accept-ranges" }, "CacheControl": { "type": "string", "location": "header", "location_name": "Cache-Control", "documentation": "Specifies caching behavior along the request/reply chain." }, "ContentDisposition": { "type": "string", "location": "header", "location_name": "Content-Disposition", "documentation": "Specifies presentational information for the object." }, "ContentEncoding": { "type": "string", "location": "header", "location_name": "Content-Encoding", "documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." }, "ContentLanguage": { "type": "string", "location": "header", "location_name": "Content-Language", "documentation": "The language the content is in." }, "ContentLength": { "type": "integer", "location": "header", "location_name": "Content-Length", "documentation": "Size of the body in bytes." }, "ContentType": { "type": "string", "location": "header", "location_name": "Content-Type", "documentation": "A standard MIME type describing the format of the object data." }, "DeleteMarker": { "type": "boolean", "location": "header", "location_name": "x-amz-delete-marker", "documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response." }, "ETag": { "type": "string", "location": "header", "location_name": "ETag", "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL" }, "Expiration": { "type": "string", "location": "header", "location_name": "x-amz-expiration", "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded." }, "Expires": { "type": "timestamp", "location": "header", "location_name": "Expires", "documentation": "The date and time at which the object is no longer cacheable." }, "LastModified": { "type": "timestamp", "location": "header", "location_name": "Last-Modified", "documentation": "Last modified date of the object" }, "Metadata": { "type": "map", "location": "header", "location_name": "x-amz-meta-", "members": { "type": "string", "documentation": "The metadata value." }, "documentation": "A map of metadata to store with the object in S3.", "keys": { "type": "string", "documentation": "The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers." } }, "MissingMeta": { "type": "integer", "location": "header", "location_name": "x-amz-missing-meta", "documentation": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers." }, "Restore": { "type": "string", "location": "header", "location_name": "x-amz-restore", "documentation": "Provides information about object restoration operation and expiration time of the restored object copy." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "VersionId": { "type": "string", "location": "header", "location_name": "x-amz-version-id", "documentation": "Version of the object." }, "WebsiteRedirectLocation": { "type": "string", "location": "header", "location_name": "x-amz-website-redirect-location", "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata." } } }, "errors": [ { "shape_name": "NoSuchKey", "type": "structure", "documentation": "The specified key does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectHEAD.html", "documentation": "The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object." }, "ListBuckets": { "name": "ListBuckets", "alias": "GetService", "http": { "method": "GET", "uri": "/" }, "input": null, "output": { "shape_name": "ListBucketsOutput", "type": "structure", "members": { "Buckets": { "type": "list", "members": { "type": "structure", "xmlname": "Bucket", "members": { "CreationDate": { "type": "timestamp", "documentation": "Date the bucket was created." }, "Name": { "type": "string", "documentation": "The name of the bucket." } } } }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTServiceGET.html", "documentation": "Returns a list of all buckets owned by the authenticated sender of the request." }, "ListMultipartUploads": { "name": "ListMultipartUploads", "http": { "method": "GET", "uri": "/{Bucket}?uploads&prefix={Prefix}&delimiter={Delimiter}&max-uploads={MaxUploads}&key-marker={KeyMarker}&upload-id-marker={UploadIdMarker}&encoding-type={EncodingType}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Delimiter": { "type": "string", "location": "uri", "documentation": "Character you use to group keys." }, "EncodingType": { "type": "string", "location": "uri", "enum": [ "url" ], "documentation": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response." }, "KeyMarker": { "type": "string", "location": "uri", "documentation": "Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin." }, "MaxUploads": { "type": "integer", "location": "uri", "documentation": "Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response." }, "Prefix": { "type": "string", "location": "uri", "documentation": "Lists in-progress uploads only for those keys that begin with the specified prefix." }, "UploadIdMarker": { "type": "string", "location": "uri", "documentation": "Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored." } } }, "output": { "shape_name": "ListMultipartUploadsOutput", "type": "structure", "members": { "Bucket": { "type": "string", "documentation": "Name of the bucket to which the multipart upload was initiated." }, "CommonPrefixes": { "type": "list", "members": { "type": "structure", "members": { "Prefix": { "type": "string" } } }, "flattened": true }, "EncodingType": { "type": "string", "location": "header", "location_name": "Encoding-Type", "documentation": "Encoding type used by Amazon S3 to encode object keys in the response." }, "IsTruncated": { "type": "boolean", "documentation": "Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads." }, "KeyMarker": { "type": "string", "documentation": "The key at or after which the listing began." }, "MaxUploads": { "type": "integer", "documentation": "Maximum number of multipart uploads that could have been included in the response." }, "NextKeyMarker": { "type": "string", "documentation": "When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request." }, "NextUploadIdMarker": { "type": "string", "documentation": "When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request." }, "Prefix": { "type": "string", "documentation": "When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix." }, "UploadIdMarker": { "type": "string", "documentation": "Upload ID after which listing began." }, "Uploads": { "type": "list", "xmlname": "Upload", "members": { "type": "structure", "members": { "Initiated": { "type": "timestamp", "documentation": "Date and time at which the multipart upload was initiated." }, "Initiator": { "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Name of the Principal." }, "ID": { "type": "string", "documentation": "If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value." } }, "documentation": "Identifies who initiated the multipart upload." }, "Key": { "type": "string", "documentation": "Key of the object for which the multipart upload was initiated." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." }, "UploadId": { "type": "string", "documentation": "Upload ID that identifies the multipart upload." } } }, "flattened": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadListMPUpload.html", "documentation": "This operation lists in-progress multipart uploads.", "pagination": { "limit_key": "MaxUploads", "more_key": "IsTruncated", "output_token": [ "NextKeyMarker", "NextUploadIdMarker" ], "input_token": [ "KeyMarker", "UploadIdMarker" ], "result_key": "Uploads", "py_input_token": [ "key_marker", "upload_id_marker" ] } }, "ListObjectVersions": { "name": "ListObjectVersions", "alias": "GetBucketObjectVersions", "http": { "method": "GET", "uri": "/{Bucket}?versions&delimiter={Delimiter}&key-marker={KeyMarker}&max-keys={MaxKeys}&prefix={Prefix}&version-id-marker={VersionIdMarker}&encoding-type={EncodingType}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Delimiter": { "type": "string", "location": "uri", "documentation": "A delimiter is a character you use to group keys." }, "EncodingType": { "type": "string", "location": "uri", "enum": [ "url" ], "documentation": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response." }, "KeyMarker": { "type": "string", "location": "uri", "documentation": "Specifies the key to start with when listing objects in a bucket." }, "MaxKeys": { "type": "integer", "location": "uri", "documentation": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." }, "Prefix": { "type": "string", "location": "uri", "documentation": "Limits the response to keys that begin with the specified prefix." }, "VersionIdMarker": { "type": "string", "location": "uri", "documentation": "Specifies the object version you want to start listing from." } } }, "output": { "shape_name": "ListObjectVersionsOutput", "type": "structure", "members": { "CommonPrefixes": { "type": "list", "members": { "type": "structure", "members": { "Prefix": { "type": "string" } } }, "flattened": true }, "DeleteMarkers": { "type": "list", "xmlname": "DeleteMarker", "members": { "type": "structure", "members": { "IsLatest": { "type": "boolean", "documentation": "Specifies whether the object is (true) or is not (false) the latest version of an object." }, "Key": { "type": "string", "documentation": "The object key." }, "LastModified": { "type": "timestamp", "documentation": "Date and time the object was last modified." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } }, "VersionId": { "type": "string", "documentation": "Version ID of an object." } } }, "flattened": true }, "EncodingType": { "type": "string", "location": "header", "location_name": "Encoding-Type", "documentation": "Encoding type used by Amazon S3 to encode object keys in the response." }, "IsTruncated": { "type": "boolean", "documentation": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results." }, "KeyMarker": { "type": "string", "documentation": "Marks the last Key returned in a truncated response." }, "MaxKeys": { "type": "integer" }, "Name": { "type": "string" }, "NextKeyMarker": { "type": "string", "documentation": "Use this value for the key marker request parameter in a subsequent request." }, "NextVersionIdMarker": { "type": "string", "documentation": "Use this value for the next version id marker parameter in a subsequent request." }, "Prefix": { "type": "string" }, "VersionIdMarker": { "type": "string" }, "Versions": { "type": "list", "xmlname": "Version", "members": { "type": "structure", "members": { "ETag": { "type": "string" }, "IsLatest": { "type": "boolean", "documentation": "Specifies whether the object is (true) or is not (false) the latest version of an object." }, "Key": { "type": "string", "documentation": "The object key." }, "LastModified": { "type": "timestamp", "documentation": "Date and time the object was last modified." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } }, "Size": { "type": "string", "documentation": "Size in bytes of the object." }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." }, "VersionId": { "type": "string", "documentation": "Version ID of an object." } } }, "flattened": true } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETVersion.html", "documentation": "Returns metadata about all of the versions of objects in a bucket.", "pagination": { "more_key": "IsTruncated", "limit_key": "MaxKeys", "output_token": [ "NextKeyMarker", "NextVersionIdMarker" ], "input_token": [ "KeyMarker", "VersionIdMarker" ], "result_key": [ "Versions", "DeleteMarkers" ], "py_input_token": [ "key_marker", "version_id_marker" ] } }, "ListObjects": { "name": "ListObjects", "alias": "GetBucket", "http": { "method": "GET", "uri": "/{Bucket}?delimiter={Delimiter}&marker={Marker}&max-keys={MaxKeys}&prefix={Prefix}&encoding-type={EncodingType}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Delimiter": { "type": "string", "location": "uri", "documentation": "A delimiter is a character you use to group keys." }, "EncodingType": { "type": "string", "location": "uri", "enum": [ "url" ], "documentation": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response." }, "Marker": { "type": "string", "location": "uri", "documentation": "Specifies the key to start with when listing objects in a bucket." }, "MaxKeys": { "type": "integer", "location": "uri", "documentation": "Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." }, "Prefix": { "type": "string", "location": "uri", "documentation": "Limits the response to keys that begin with the specified prefix." } } }, "output": { "shape_name": "ListObjectsOutput", "type": "structure", "members": { "CommonPrefixes": { "type": "list", "members": { "type": "structure", "members": { "Prefix": { "type": "string" } } }, "flattened": true }, "Contents": { "type": "list", "members": { "type": "structure", "members": { "ETag": { "type": "string" }, "Key": { "type": "string" }, "LastModified": { "type": "timestamp" }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } }, "Size": { "type": "integer" }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." } } }, "flattened": true }, "EncodingType": { "type": "string", "location": "header", "location_name": "Encoding-Type", "documentation": "Encoding type used by Amazon S3 to encode object keys in the response." }, "IsTruncated": { "type": "boolean", "documentation": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria." }, "Marker": { "type": "string" }, "MaxKeys": { "type": "integer" }, "Name": { "type": "string" }, "NextMarker": { "type": "string", "documentation": "When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys." }, "Prefix": { "type": "string" } } }, "errors": [ { "shape_name": "NoSuchBucket", "type": "structure", "documentation": "The specified bucket does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html", "documentation": "Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.", "pagination": { "more_key": "IsTruncated", "limit_key": "MaxKeys", "output_token": "NextMarker || Contents[-1].Key", "input_token": "Marker", "result_key": [ "Contents", "CommonPrefixes" ], "py_input_token": "marker" } }, "ListParts": { "name": "ListParts", "http": { "method": "GET", "uri": "/{Bucket}/{Key}?uploadId={UploadId}&max-parts={MaxParts}&part-number-marker={PartNumberMarker}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "MaxParts": { "type": "integer", "location": "uri", "documentation": "Sets the maximum number of parts to return." }, "PartNumberMarker": { "type": "integer", "location": "uri", "documentation": "Specifies the part after which listing should begin. Only parts with higher part numbers will be listed." }, "UploadId": { "type": "string", "required": true, "location": "uri", "documentation": "Upload ID identifying the multipart upload whose parts are being listed." } } }, "output": { "shape_name": "ListPartsOutput", "type": "structure", "members": { "Bucket": { "type": "string", "documentation": "Name of the bucket to which the multipart upload was initiated." }, "Initiator": { "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Name of the Principal." }, "ID": { "type": "string", "documentation": "If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value." } }, "documentation": "Identifies who initiated the multipart upload." }, "IsTruncated": { "type": "boolean", "documentation": "Indicates whether the returned list of parts is truncated." }, "Key": { "type": "string", "documentation": "Object key for which the multipart upload was initiated." }, "MaxParts": { "type": "integer", "documentation": "Maximum number of parts that were allowed in the response." }, "NextPartNumberMarker": { "type": "integer", "documentation": "When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } }, "PartNumberMarker": { "type": "integer", "documentation": "Part number after which listing begins." }, "Parts": { "type": "list", "xmlname": "Part", "members": { "type": "structure", "members": { "ETag": { "type": "string", "documentation": "Entity tag returned when the part was uploaded." }, "LastModified": { "type": "timestamp", "documentation": "Date and time at which the part was uploaded." }, "PartNumber": { "type": "integer", "documentation": "Part number identifying the part." }, "Size": { "type": "integer", "documentation": "Size of the uploaded part data." } } }, "flattened": true }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." }, "UploadId": { "type": "string", "documentation": "Upload ID identifying the multipart upload whose parts are being listed." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadListParts.html", "documentation": "Lists the parts that have been uploaded for a specific multipart upload.", "pagination": { "more_key": "IsTruncated", "limit_key": "MaxParts", "output_token": "NextPartNumberMarker", "input_token": "PartNumberMarker", "result_key": "Parts", "py_input_token": "part_number_marker" } }, "PutBucketAcl": { "name": "PutBucketAcl", "http": { "method": "PUT", "uri": "/{Bucket}?acl" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the bucket." }, "AccessControlPolicy": { "type": "structure", "payload": true, "members": { "Grants": { "type": "list", "xmlname": "AccessControlList", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "required": true, "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string", "enum": [ "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP" ], "documentation": "Specifies the permission given to the grantee." } } }, "documentation": "A list of grants." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } } } }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to list the objects in the bucket." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the bucket ACL." }, "GrantWrite": { "type": "string", "location": "header", "location_name": "x-amz-grant-write", "documentation": "Allows grantee to create, overwrite, and delete any object in the bucket." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable bucket." } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html", "documentation": "Sets the permissions on a bucket using access control lists (ACL)." }, "PutBucketCors": { "name": "PutBucketCors", "http": { "method": "PUT", "uri": "/{Bucket}?cors" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "CORSConfiguration": { "type": "structure", "payload": true, "members": { "CORSRules": { "type": "list", "xmlname": "CORSRule", "members": { "type": "structure", "members": { "AllowedHeaders": { "type": "list", "xmlname": "AllowedHeader", "members": { "type": "string" }, "documentation": "Specifies which headers are allowed in a pre-flight OPTIONS request.", "flattened": true }, "AllowedMethods": { "type": "list", "xmlname": "AllowedMethod", "members": { "type": "string" }, "documentation": "Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.", "flattened": true }, "AllowedOrigins": { "type": "list", "xmlname": "AllowedOrigin", "members": { "type": "string" }, "documentation": "One or more origins you want customers to be able to access the bucket from.", "flattened": true }, "ExposeHeaders": { "type": "list", "xmlname": "ExposeHeader", "members": { "type": "string" }, "documentation": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).", "flattened": true }, "MaxAgeSeconds": { "type": "integer", "documentation": "The time in seconds that your browser is to cache the preflight response for the specified resource." } } }, "flattened": true } } }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTcors.html", "documentation": "Sets the cors configuration for a bucket." }, "PutBucketLifecycle": { "name": "PutBucketLifecycle", "http": { "method": "PUT", "uri": "/{Bucket}?lifecycle" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "LifecycleConfiguration": { "type": "structure", "payload": true, "members": { "Rules": { "type": "list", "required": true, "xmlname": "Rule", "members": { "type": "structure", "members": { "Expiration": { "type": "structure", "members": { "Date": { "type": "timestamp", "documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.", "timestamp_format": "iso8601" }, "Days": { "type": "integer", "documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." } } }, "ID": { "type": "string", "documentation": "Unique identifier for the rule. The value cannot be longer than 255 characters." }, "Prefix": { "type": "string", "required": true, "documentation": "Prefix identifying one or more objects to which the rule applies." }, "Status": { "type": "string", "required": true, "enum": [ "Enabled", "Disabled" ], "documentation": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." }, "Transition": { "type": "structure", "members": { "Date": { "type": "timestamp", "documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.", "timestamp_format": "iso8601" }, "Days": { "type": "integer", "documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." }, "StorageClass": { "type": "string", "enum": [ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ], "documentation": "The class of storage used to store the object." } } } } }, "flattened": true } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", "documentation": "Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it." }, "PutBucketLogging": { "name": "PutBucketLogging", "http": { "method": "PUT", "uri": "/{Bucket}?logging" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "BucketLoggingStatus": { "type": "structure", "payload": true, "required": true, "members": { "LoggingEnabled": { "type": "structure", "members": { "TargetBucket": { "type": "string", "documentation": "Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key." }, "TargetGrants": { "type": "list", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "required": true, "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string" } } } }, "TargetPrefix": { "type": "string", "documentation": "This element lets you specify a prefix for the keys that the log files will be stored under." } } } } }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html", "documentation": "Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner." }, "PutBucketNotification": { "name": "PutBucketNotification", "http": { "method": "PUT", "uri": "/{Bucket}?notification" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "NotificationConfiguration": { "type": "structure", "payload": true, "required": true, "members": { "TopicConfiguration": { "type": "structure", "required": true, "members": { "Event": { "type": "string", "enum": [ "s3:ReducedRedundancyLostObject" ], "documentation": "Bucket event for which to send notifications." }, "Topic": { "type": "string", "documentation": "Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." } } } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTnotification.html", "documentation": "Enables notifications of specified events for a bucket." }, "PutBucketPolicy": { "name": "PutBucketPolicy", "http": { "method": "PUT", "uri": "/{Bucket}?policy" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "Policy": { "type": "string", "payload": true, "required": true, "documentation": "The bucket policy as a JSON document." } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html", "documentation": "Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it." }, "PutBucketRequestPayment": { "name": "PutBucketRequestPayment", "http": { "method": "PUT", "uri": "/{Bucket}?requestPayment" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "RequestPaymentConfiguration": { "type": "structure", "payload": true, "required": true, "members": { "Payer": { "type": "string", "required": true, "enum": [ "Requester", "BucketOwner" ], "documentation": "Specifies who pays for the download and request fees." } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html", "documentation": "Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download." }, "PutBucketTagging": { "name": "PutBucketTagging", "http": { "method": "PUT", "uri": "/{Bucket}?tagging" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "Tagging": { "type": "structure", "payload": true, "required": true, "members": { "TagSet": { "type": "list", "required": true, "members": { "type": "structure", "required": true, "xmlname": "Tag", "members": { "Key": { "type": "string", "required": true, "documentation": "Name of the tag." }, "Value": { "type": "string", "required": true, "documentation": "Value of the tag." } } } } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTtagging.html", "documentation": "Sets the tags for a bucket." }, "PutBucketVersioning": { "name": "PutBucketVersioning", "http": { "method": "PUT", "uri": "/{Bucket}?versioning" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "MFA": { "type": "string", "location": "header", "location_name": "x-amz-mfa", "documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device." }, "VersioningConfiguration": { "type": "structure", "payload": true, "required": true, "members": { "MfaDelete": { "type": "string", "enum": [ "Enabled", "Disabled" ], "documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned." }, "Status": { "type": "string", "enum": [ "Enabled", "Suspended" ], "documentation": "The versioning state of the bucket." } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html", "documentation": "Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner." }, "PutBucketWebsite": { "name": "PutBucketWebsite", "http": { "method": "PUT", "uri": "/{Bucket}?website" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "WebsiteConfiguration": { "type": "structure", "payload": true, "required": true, "members": { "ErrorDocument": { "type": "structure", "members": { "Key": { "type": "string", "required": true, "documentation": "The object key name to use when a 4XX class error occurs." } } }, "IndexDocument": { "type": "structure", "members": { "Suffix": { "type": "string", "required": true, "documentation": "A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character." } } }, "RedirectAllRequestsTo": { "type": "structure", "members": { "HostName": { "type": "string", "required": true, "documentation": "Name of the host where requests will be redirected." }, "Protocol": { "type": "string", "enum": [ "http", "https" ], "documentation": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." } } }, "RoutingRules": { "type": "list", "members": { "type": "structure", "xmlname": "RoutingRule", "members": { "Condition": { "type": "structure", "members": { "HttpErrorCodeReturnedEquals": { "type": "string", "documentation": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied." }, "KeyPrefixEquals": { "type": "string", "documentation": "The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied." } }, "documentation": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." }, "Redirect": { "type": "structure", "required": true, "members": { "HostName": { "type": "string", "documentation": "The host name to use in the redirect request." }, "HttpRedirectCode": { "type": "string", "documentation": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." }, "Protocol": { "type": "string", "enum": [ "http", "https" ], "documentation": "Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." }, "ReplaceKeyPrefixWith": { "type": "string", "documentation": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided." }, "ReplaceKeyWith": { "type": "string", "documentation": "The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided." } }, "documentation": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return." } } } } } } } }, "output": null, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html", "documentation": "Set the website configuration for a bucket." }, "PutObject": { "name": "PutObject", "http": { "method": "PUT", "uri": "/{Bucket}/{Key}" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the object." }, "Body": { "type": "blob", "payload": true, "streaming": true }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "CacheControl": { "type": "string", "location": "header", "location_name": "Cache-Control", "documentation": "Specifies caching behavior along the request/reply chain." }, "ContentDisposition": { "type": "string", "location": "header", "location_name": "Content-Disposition", "documentation": "Specifies presentational information for the object." }, "ContentEncoding": { "type": "string", "location": "header", "location_name": "Content-Encoding", "documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field." }, "ContentLanguage": { "type": "string", "location": "header", "location_name": "Content-Language", "documentation": "The language the content is in." }, "ContentLength": { "type": "integer", "location": "header", "location_name": "Content-Length", "documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "ContentType": { "type": "string", "location": "header", "location_name": "Content-Type", "documentation": "A standard MIME type describing the format of the object data." }, "Expires": { "type": "timestamp", "location": "header", "location_name": "Expires", "documentation": "The date and time at which the object is no longer cacheable." }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to read the object data and its metadata." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the object ACL." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable object." }, "Key": { "type": "string", "required": true, "location": "uri" }, "Metadata": { "type": "map", "location": "header", "location_name": "x-amz-meta-", "members": { "type": "string", "documentation": "The metadata value." }, "documentation": "A map of metadata to store with the object in S3.", "keys": { "type": "string", "documentation": "The metadata key. This will be prefixed with x-amz-meta- before sending to S3 as a header. The x-amz-meta- header will be stripped from the key when retrieving headers." } }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "StorageClass": { "type": "string", "location": "header", "location_name": "x-amz-storage-class", "enum": [ "STANDARD", "REDUCED_REDUNDANCY" ], "documentation": "The type of storage to use for the object. Defaults to 'STANDARD'." }, "WebsiteRedirectLocation": { "type": "string", "location": "header", "location_name": "x-amz-website-redirect-location", "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.", "no_paramfile": true } } }, "output": { "shape_name": "PutObjectOutput", "type": "structure", "members": { "ETag": { "type": "string", "location": "header", "location_name": "ETag", "documentation": "Entity tag for the uploaded object." }, "Expiration": { "type": "timestamp", "location": "header", "location_name": "x-amz-expiration", "documentation": "If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." }, "VersionId": { "type": "string", "location": "header", "location_name": "x-amz-version-id", "documentation": "Version of the object." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html", "documentation": "Adds an object to a bucket." }, "PutObjectAcl": { "name": "PutObjectAcl", "http": { "method": "PUT", "uri": "/{Bucket}/{Key}?acl" }, "input": { "type": "structure", "members": { "ACL": { "type": "string", "location": "header", "location_name": "x-amz-acl", "enum": [ "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control" ], "documentation": "The canned ACL to apply to the bucket." }, "AccessControlPolicy": { "type": "structure", "payload": true, "members": { "Grants": { "type": "list", "xmlname": "AccessControlList", "members": { "type": "structure", "xmlname": "Grant", "members": { "Grantee": { "xmlnamespace": { "uri": "http://www.w3.org/2001/XMLSchema-instance", "prefix": "xsi" }, "type": "structure", "members": { "DisplayName": { "type": "string", "documentation": "Screen name of the grantee." }, "EmailAddress": { "type": "string", "documentation": "Email address of the grantee." }, "ID": { "type": "string", "documentation": "The canonical user ID of the grantee." }, "Type": { "type": "string", "required": true, "xmlname": "xsi:type", "xmlattribute": true, "enum": [ "CanonicalUser", "AmazonCustomerByEmail", "Group" ], "documentation": "Type of grantee" }, "URI": { "type": "string", "documentation": "URI of the grantee group." } } }, "Permission": { "type": "string", "enum": [ "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP" ], "documentation": "Specifies the permission given to the grantee." } } }, "documentation": "A list of grants." }, "Owner": { "type": "structure", "members": { "DisplayName": { "type": "string" }, "ID": { "type": "string" } } } } }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "GrantFullControl": { "type": "string", "location": "header", "location_name": "x-amz-grant-full-control", "documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket." }, "GrantRead": { "type": "string", "location": "header", "location_name": "x-amz-grant-read", "documentation": "Allows grantee to list the objects in the bucket." }, "GrantReadACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-read-acp", "documentation": "Allows grantee to read the bucket ACL." }, "GrantWrite": { "type": "string", "location": "header", "location_name": "x-amz-grant-write", "documentation": "Allows grantee to create, overwrite, and delete any object in the bucket." }, "GrantWriteACP": { "type": "string", "location": "header", "location_name": "x-amz-grant-write-acp", "documentation": "Allows grantee to write the ACL for the applicable bucket." }, "Key": { "type": "string", "required": true, "location": "uri" } } }, "output": null, "errors": [ { "shape_name": "NoSuchKey", "type": "structure", "documentation": "The specified key does not exist." } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUTacl.html", "documentation": "uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket" }, "RestoreObject": { "name": "RestoreObject", "alias": "PostObjectRestore", "http": { "method": "POST", "uri": "/{Bucket}/{Key}?restore" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "Key": { "type": "string", "required": true, "location": "uri" }, "RestoreRequest": { "type": "structure", "payload": true, "members": { "Days": { "type": "integer", "required": true, "documentation": "Lifetime of the active copy in days" } } } } }, "output": null, "errors": [ { "shape_name": "ObjectAlreadyInActiveTierError", "type": "structure", "documentation": "This operation is not allowed against this storage tier" } ], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectRestore.html", "documentation": "Restores an archived copy of an object back into Amazon S3" }, "UploadPart": { "name": "UploadPart", "http": { "method": "PUT", "uri": "/{Bucket}/{Key}?partNumber={PartNumber}&uploadId={UploadId}" }, "input": { "type": "structure", "members": { "Body": { "type": "blob", "payload": true, "streaming": true }, "Bucket": { "type": "string", "required": true, "location": "uri" }, "ContentLength": { "type": "integer", "location": "header", "location_name": "Content-Length", "documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically." }, "ContentMD5": { "type": "string", "location": "header", "location_name": "Content-MD5" }, "Key": { "type": "string", "required": true, "location": "uri" }, "PartNumber": { "type": "integer", "required": true, "location": "uri", "documentation": "Part number of part being uploaded." }, "UploadId": { "type": "string", "required": true, "location": "uri", "documentation": "Upload ID identifying the multipart upload whose part is being uploaded." } } }, "output": { "shape_name": "UploadPartOutput", "type": "structure", "members": { "ETag": { "type": "string", "location": "header", "location_name": "ETag", "documentation": "Entity tag for the uploaded object." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadUploadPart.html", "documentation": "

Uploads a part in a multipart upload.

Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

" }, "UploadPartCopy": { "name": "UploadPartCopy", "http": { "method": "PUT", "uri": "/{Bucket}/{Key}?partNumber={PartNumber}&uploadId={UploadId}" }, "input": { "type": "structure", "members": { "Bucket": { "type": "string", "required": true, "location": "uri" }, "CopySource": { "type": "string", "required": true, "location": "header", "location_name": "x-amz-copy-source", "documentation": "The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.", "pattern": "\\/.+\\/.+" }, "CopySourceIfMatch": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-match", "documentation": "Copies the object if its entity tag (ETag) matches the specified tag." }, "CopySourceIfModifiedSince": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-modified-since", "documentation": "Copies the object if it has been modified since the specified time." }, "CopySourceIfNoneMatch": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-none-match", "documentation": "Copies the object if its entity tag (ETag) is different than the specified ETag." }, "CopySourceIfUnmodifiedSince": { "type": "timestamp", "location": "header", "location_name": "x-amz-copy-source-if-unmodified-since", "documentation": "Copies the object if it hasn't been modified since the specified time." }, "CopySourceRange": { "type": "string", "location": "header", "location_name": "x-amz-copy-source-range", "documentation": "The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB." }, "Key": { "type": "string", "required": true, "location": "uri" }, "PartNumber": { "type": "integer", "required": true, "location": "uri", "documentation": "Part number of part being copied." }, "UploadId": { "type": "string", "required": true, "location": "uri", "documentation": "Upload ID identifying the multipart upload whose part is being copied." } } }, "output": { "shape_name": "UploadPartCopyOutput", "type": "structure", "members": { "CopyPartResult": { "type": "structure", "payload": true, "members": { "ETag": { "type": "string", "documentation": "Entity tag of the object." }, "LastModified": { "type": "timestamp", "documentation": "Date and time at which the object was uploaded." } } }, "CopySourceVersionId": { "type": "string", "location": "header", "location_name": "x-amz-copy-source-version-id", "documentation": "The version of the source object that was copied, if you have enabled versioning on the source bucket." }, "ServerSideEncryption": { "type": "string", "location": "header", "location_name": "x-amz-server-side-encryption", "enum": [ "AES256" ], "documentation": "The Server-side encryption algorithm used when storing this object in S3." } } }, "errors": [], "documentation_url": "http://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", "documentation": "Uploads a part by copying data from an existing object as data source." } }, "metadata": { "regions": { "us-east-1": "https://s3.amazonaws.com/", "ap-northeast-1": "https://s3-ap-northeast-1.amazonaws.com/", "sa-east-1": "https://s3-sa-east-1.amazonaws.com/", "ap-southeast-1": "https://s3-ap-southeast-1.amazonaws.com/", "ap-southeast-2": "https://s3-ap-southeast-2.amazonaws.com/", "us-west-2": "https://s3-us-west-2.amazonaws.com/", "us-west-1": "https://s3-us-west-1.amazonaws.com/", "eu-west-1": "https://s3-eu-west-1.amazonaws.com/", "us-gov-west-1": "https://s3-us-gov-west-1.amazonaws.com/", "fips-gov-west-1": "https://s3-fips-us-gov-west-1.amazonaws.com/", "cn-north-1": "https://s3.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "pagination": { "ListMultipartUploads": { "limit_key": "MaxUploads", "more_key": "IsTruncated", "output_token": [ "NextKeyMarker", "NextUploadIdMarker" ], "input_token": [ "KeyMarker", "UploadIdMarker" ], "result_key": "Uploads", "py_input_token": [ "key_marker", "upload_id_marker" ] }, "ListObjectVersions": { "more_key": "IsTruncated", "limit_key": "MaxKeys", "output_token": [ "NextKeyMarker", "NextVersionIdMarker" ], "input_token": [ "KeyMarker", "VersionIdMarker" ], "result_key": [ "Versions", "DeleteMarkers" ], "py_input_token": [ "key_marker", "version_id_marker" ] }, "ListObjects": { "more_key": "IsTruncated", "limit_key": "MaxKeys", "output_token": "NextMarker || Contents[-1].Key", "input_token": "Marker", "result_key": [ "Contents", "CommonPrefixes" ], "py_input_token": "marker" }, "ListParts": { "more_key": "IsTruncated", "limit_key": "MaxParts", "output_token": "NextPartNumberMarker", "input_token": "PartNumberMarker", "result_key": "Parts", "py_input_token": "part_number_marker" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "timeouts": { "applies_when": { "response": { "http_status_code": 400, "service_error_code": "RequestTimeout" } } } } } } }botocore-0.29.0/botocore/data/aws/ses.json0000644000175000017500000024641612254746566017752 0ustar takakitakaki{ "api_version": "2010-12-01", "type": "query", "result_wrapped": true, "signature_version": "v4", "signing_name": "ses", "service_full_name": "Amazon Simple Email Service", "service_abbreviation": "Amazon SES", "endpoint_prefix": "email", "xmlnamespace": "http://ses.amazonaws.com/doc/2010-12-01/", "documentation": "\n Amazon Simple Email Service\n

\n This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be\n used in conjunction with the Amazon SES Developer Guide.\n

\n

\n For specific details on how to construct a service request, please consult the Amazon SES Developer Guide.\n

\n The endpoint for Amazon SES is located at:\n https://email.us-east-1.amazonaws.com\n \n ", "operations": { "DeleteIdentity": { "name": "DeleteIdentity", "input": { "shape_name": "DeleteIdentityRequest", "type": "structure", "members": { "Identity": { "shape_name": "Identity", "type": "string", "documentation": "\n

The identity to be removed from the list of identities for the AWS Account.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to delete an identity from the list of identities for the AWS Account.

\n " }, "output": { "shape_name": "DeleteIdentityResponse", "type": "structure", "members": {}, "documentation": "\n

An empty element. Receiving this element indicates that the request completed successfully.

\n " }, "errors": [], "documentation": "\n

Deletes the specified identity (email address or domain) from the list of verified identities.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:25:58 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=w943pl3zIvtszwzZxypi+LsgjzquvhYhnG42S6b2WLo=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 135\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=DeleteIdentity\n&Identity=domain.com\n&Timestamp=2012-05-12T05%3A25%3A58.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n d96bd874-9bf2-11e1-8ee7-c98a0037a2b6\n \n\n \n \n \n " }, "DeleteVerifiedEmailAddress": { "name": "DeleteVerifiedEmailAddress", "input": { "shape_name": "DeleteVerifiedEmailAddressRequest", "type": "structure", "members": { "EmailAddress": { "shape_name": "Address", "type": "string", "documentation": "\n

An email address to be removed from the list of verified addresses.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to delete an address from the list of verified email addresses.

\n " }, "output": null, "errors": [], "documentation": "\n

Deletes the specified email address from the list of verified addresses.

\n The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release\n of Domain Verification. The DeleteIdentity action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:20:50 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=Rxzyd6cQe/YjkV4yoQAZ243OzzNjFgrsclizTKwRIRc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 142\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=DeleteVerifiedEmailAddress\n&EmailAddress=user%40example.com\n&Timestamp=2011-08-18T22%3A20%3A50.000Z\n \n \n \n \n\n \n 5634af08-c865-11e0-8986-3f99a698f914\n \n\n \n \n \n " }, "GetIdentityDkimAttributes": { "name": "GetIdentityDkimAttributes", "input": { "shape_name": "GetIdentityDkimAttributesRequest", "type": "structure", "members": { "Identities": { "shape_name": "IdentityList", "type": "list", "members": { "shape_name": "Identity", "type": "string", "documentation": null }, "documentation": "\n

A list of one or more verified identities - email addresses, domains, or both.

\n ", "required": true } }, "documentation": "\n

Given a list of verified identities, describes their DKIM attributes. The DKIM attributes of an email address\n identity includes whether DKIM signing is individually enabled or disabled for that address. The DKIM attributes\n of a domain name identity includes whether DKIM signing is enabled, as well as the DNS records (tokens)\n that must remain published in the domain name's DNS.

\n " }, "output": { "shape_name": "GetIdentityDkimAttributesResponse", "type": "structure", "members": { "DkimAttributes": { "shape_name": "DkimAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityDkimAttributes", "type": "structure", "members": { "DkimEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\n

True if DKIM signing is enabled for email sent from the identity; false otherwise.

\n ", "required": true }, "DkimVerificationStatus": { "shape_name": "VerificationStatus", "type": "string", "enum": [ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ], "documentation": "\n

Describes whether Amazon SES has successfully verified the DKIM DNS records\n (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

\n ", "required": true }, "DkimTokens": { "shape_name": "VerificationTokenList", "type": "list", "members": { "shape_name": "VerificationToken", "type": "string", "documentation": null }, "documentation": "\n

A set of character strings that represent the domain's identity. Using these tokens, you\n will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon\n SES. Amazon Web Services will eventually detect that you have updated your DNS records;\n this detection process may take up to 72 hours. Upon successful detection, Amazon SES\n will be able to DKIM-sign email originating from that domain. (This only applies to\n domain identities, not email address identities.)

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n " } }, "documentation": "\n

Represents the DKIM attributes of a verified email address or a domain.

\n " }, "documentation": "\n

The DKIM attributes for an email address or a domain.

\n ", "required": true } }, "documentation": "\n

Represents a list of all the DKIM attributes for the specified identity.

\n \n " }, "errors": [], "documentation": "\n

Returns the current status of Easy DKIM signing for an entity. For domain name\n identities, this action also returns the DKIM tokens that are required for Easy DKIM\n signing, and whether Amazon SES has successfully verified that these tokens have been\n published.

\n

This action takes a list of identities as input and returns the following\n information for each:

\n \n

This action is throttled at one request per second.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:41:32 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE, \n Signature=MJdhrIAt3c4BRC6jdzueMM+AJLEx17bnIHjZwlSenyk=, \n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 165\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityDkimAttributes\n&Identities.member.1=example.com\n&Timestamp=2012-06-29T22%3A41%3A32.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n amazon.com\n \n true\n Success\n \n vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6f\n 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy\n wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2\n \n \n \n \n \n \n bb5a105d-c468-11e1-82eb-dff885ccc06a\n \n\n \n \n \n " }, "GetIdentityNotificationAttributes": { "name": "GetIdentityNotificationAttributes", "input": { "shape_name": "GetIdentityNotificationAttributesRequest", "type": "structure", "members": { "Identities": { "shape_name": "IdentityList", "type": "list", "members": { "shape_name": "Identity", "type": "string", "documentation": null }, "documentation": "\n

A list of one or more identities.

\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "GetIdentityNotificationAttributesResponse", "type": "structure", "members": { "NotificationAttributes": { "shape_name": "NotificationAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityNotificationAttributes", "type": "structure", "members": { "BounceTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n where Amazon SES will publish bounce notifications.

\n ", "required": true }, "ComplaintTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic \n where Amazon SES will publish complaint notifications.

\n ", "required": true }, "ForwardingEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\n

Describes whether Amazon SES will forward feedback as email. true indicates \n that Amazon SES will forward feedback as email, while false indicates that \n feedback will be published only to the specified Bounce and Complaint topics.

\n ", "required": true } }, "documentation": "\n

Represents the notification attributes of an identity, including whether a bounce \n or complaint topic are set, and whether feedback forwarding is enabled.

\n " }, "documentation": "\n

A map of Identity to IdentityNotificationAttributes.

\n ", "required": true } }, "documentation": "\n

Describes whether an identity has a bounce topic or complaint topic set, or feedback \n forwarding enabled.

\n " }, "errors": [], "documentation": "\n

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity \n notification attributes.

\n

This action is throttled at one request per second.

\n

For more information about feedback notification, see the \n Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 15 Jun 2012 20:51:42 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=ee9aH6tUW5wBPoh01Tz3w4H+z4avrMmvmRYbfORC7OI=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 173\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityNotificationAttributes\n&Identities.member.1=user%40example.com\n&Timestamp=2012-06-15T20%3A51%3A42.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n user@example.com\n \n true\n arn:aws:sns:us-east-1:123456789012:example\n arn:aws:sns:us-east-1:123456789012:example\n \n \n \n \n \n e038e509-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n \n " }, "GetIdentityVerificationAttributes": { "name": "GetIdentityVerificationAttributes", "input": { "shape_name": "GetIdentityVerificationAttributesRequest", "type": "structure", "members": { "Identities": { "shape_name": "IdentityList", "type": "list", "members": { "shape_name": "Identity", "type": "string", "documentation": null }, "documentation": "\n

A list of identities.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to provide the verification attributes for a list of identities.

\n " }, "output": { "shape_name": "GetIdentityVerificationAttributesResponse", "type": "structure", "members": { "VerificationAttributes": { "shape_name": "VerificationAttributes", "type": "map", "keys": { "shape_name": "Identity", "type": "string", "documentation": null }, "members": { "shape_name": "IdentityVerificationAttributes", "type": "structure", "members": { "VerificationStatus": { "shape_name": "VerificationStatus", "type": "string", "enum": [ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ], "documentation": "\n

The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".

\n ", "required": true }, "VerificationToken": { "shape_name": "VerificationToken", "type": "string", "documentation": "\n

The verification token for a domain identity. Null for email address identities.

\n " } }, "documentation": "\n

Represents the verification attributes of a single identity.

\n " }, "documentation": "\n

A map of Identities to IdentityVerificationAttributes objects.

\n ", "required": true } }, "documentation": "\n

Represents the verification attributes for a list of identities.

\n " }, "errors": [], "documentation": "\n

Given a list of identities (email addresses and/or domains), returns the verification\n status and (for domain identities) the verification token for each identity.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:27:54 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=3+KQ4VHx991T7Kb41HmFcZJxuHz4/6mf2H5FxY+tuLc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 203\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetIdentityVerificationAttributes\n&Identities.member.1=user%40domain.com\n&Identities.member.2=domain.com\n&Timestamp=2012-05-12T05%3A27%3A54.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n \n domain.com\n \n Pending\n QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=\n \n \n \n user@domain.com\n \n Pending\n \n \n \n \n \n 1d0c29f1-9bf3-11e1-8ee7-c98a0037a2b6\n \n\n \n \n \n " }, "GetSendQuota": { "name": "GetSendQuota", "input": null, "output": { "shape_name": "GetSendQuotaResponse", "type": "structure", "members": { "Max24HourSend": { "shape_name": "Max24HourSend", "type": "double", "documentation": "\n

The maximum number of emails the user is allowed to send in a 24-hour interval.

\n " }, "MaxSendRate": { "shape_name": "MaxSendRate", "type": "double", "documentation": "\n

The maximum number of emails the user is allowed to send per second.

\n " }, "SentLast24Hours": { "shape_name": "SentLast24Hours", "type": "double", "documentation": "\n

The number of emails sent during the previous 24 hours.

\n " } }, "documentation": "\n

Represents the user's current activity limits returned from a successful\n GetSendQuota\n request.\n

\n " }, "errors": [], "documentation": "\n

Returns the user's current sending limits.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:22:36 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=W1YdiNOtf0jN3t7Lv63qhz7UZc3RrcmQpkGbopvnj/Y=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 94\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetSendQuota\n&Timestamp=2011-08-18T22%3A22%3A36.000Z\n \n \n \n \n\n \n 127.0\n 200.0\n 1.0\n \n \n 273021c6-c866-11e0-b926-699e21c3af9e\n \n\n \n \n \n " }, "GetSendStatistics": { "name": "GetSendStatistics", "input": null, "output": { "shape_name": "GetSendStatisticsResponse", "type": "structure", "members": { "SendDataPoints": { "shape_name": "SendDataPointList", "type": "list", "members": { "shape_name": "SendDataPoint", "type": "structure", "members": { "Timestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

Time of the data point.

\n " }, "DeliveryAttempts": { "shape_name": "Counter", "type": "long", "documentation": "\n

Number of emails that have been enqueued for sending.

\n " }, "Bounces": { "shape_name": "Counter", "type": "long", "documentation": "\n

Number of emails that have bounced.

\n " }, "Complaints": { "shape_name": "Counter", "type": "long", "documentation": "\n

Number of unwanted emails that were rejected by recipients.

\n " }, "Rejects": { "shape_name": "Counter", "type": "long", "documentation": "\n

Number of emails rejected by Amazon SES.

\n " } }, "documentation": "\n

Represents sending statistics data. Each\n SendDataPoint\n contains statistics for a 15-minute period of sending activity.\n

\n " }, "documentation": "\n

A list of data points, each of which represents 15 minutes of activity.

\n " } }, "documentation": "\n

Represents a list of\n SendDataPoint\n items returned from a successful\n GetSendStatistics\n request. This list contains aggregated data from the previous two weeks of sending activity.\n

\n " }, "errors": [], "documentation": "\n

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of\n sending activity.\n

\n

Each data point in the list contains statistics for a 15-minute interval.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:23:01 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=kwuk4eraA9HSfHySflgDKR6xK0JXjATIE7Uu5/FB4x4=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 99\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=GetSendStatistics\n&Timestamp=2011-08-18T22%3A23%3A01.000Z\n \n \n \n \n\n \n \n \n 8\n 2011-08-03T19:23:00Z\n 0\n 0\n 0\n \n \n 7\n 2011-08-03T06:53:00Z\n 0\n 0\n 0\n \n\t .\n\t .\n\t .\n\t .\n \n \n c2b66ee5-c866-11e0-b17f-cddb0ab334db\n \n\n \n \n \n " }, "ListIdentities": { "name": "ListIdentities", "input": { "shape_name": "ListIdentitiesRequest", "type": "structure", "members": { "IdentityType": { "shape_name": "IdentityType", "type": "string", "enum": [ "EmailAddress", "Domain" ], "documentation": "\n\t

The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.

\n " }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n\t

The token to use for pagination.

\n " }, "MaxItems": { "shape_name": "MaxItems", "type": "integer", "documentation": "\n\t

The maximum number of identities per page. Possible values are 1-100 inclusive.

\n " } }, "documentation": "\n\t

Represents a request instructing the service to list all identities for the AWS Account.

\n " }, "output": { "shape_name": "ListIdentitiesResponse", "type": "structure", "members": { "Identities": { "shape_name": "IdentityList", "type": "list", "members": { "shape_name": "Identity", "type": "string", "documentation": null }, "documentation": "\n

A list of identities.

\n ", "required": true }, "NextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

The token used for pagination.

\n " } }, "documentation": "\n\t

Represents a list of all verified identities for the AWS Account.

\n " }, "errors": [], "documentation": "\n

Returns a list containing all of the identities (email addresses and domains) for \n a specific AWS Account, regardless of verification status.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:18:45 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=OruiFNV26DCZicLDaQmULHGbjbU8MbC/c5aIo/MMIuM=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 115\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=ListIdentities\n&Timestamp=2012-05-12T05%3A18%3A45.000Z&\nVersion=2010-12-01\n \n \n \n \n\n \n \n example.com\n user@example.com\n \n \n \n cacecf23-9bf1-11e1-9279-0100e8cf109a\n \n\n \n \n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxItems", "result_key": "Identities", "py_input_token": "next_token" } }, "ListVerifiedEmailAddresses": { "name": "ListVerifiedEmailAddresses", "input": null, "output": { "shape_name": "ListVerifiedEmailAddressesResponse", "type": "structure", "members": { "VerifiedEmailAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

A list of email addresses that have been verified.

\n " } }, "documentation": "\n

Represents a list of all the email addresses verified for the current user.

\n " }, "errors": [], "documentation": "\n

Returns a list containing all of the email addresses that have been verified.

\n The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of \n Domain Verification. The ListIdentities action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:05:09 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=II0+vvDKGMv71vToBwzR6vZ1hxe/VUE8tWEFUNTUqgE=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 108\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=ListVerifiedEmailAddresses\n&Timestamp=2011-08-18T22%3A05%3A09.000Z%\n \n \n \n \n\n \n \n example@amazon.com\n \n \n \n 3dd50e97-c865-11e0-b235-099eb63d928d\n \n\n \n \n \n " }, "SendEmail": { "name": "SendEmail", "input": { "shape_name": "SendEmailRequest", "type": "structure", "members": { "Source": { "shape_name": "Address", "type": "string", "documentation": "\n

The identity's email address.

\n

\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. \n For more information, see RFC 2047.\n

\n ", "required": true }, "Destination": { "shape_name": "Destination", "type": "structure", "members": { "ToAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

The To: field(s) of the message.

\n " }, "CcAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

The CC: field(s) of the message.

\n " }, "BccAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

The BCC: field(s) of the message.

\n " } }, "documentation": "\n

The destination for this email, composed of To:, CC:, and BCC: fields.

\n ", "required": true }, "Message": { "shape_name": "Message", "type": "structure", "members": { "Subject": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\n

The textual data of the content.

\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\n

The character set of the content.

\n " } }, "documentation": "\n

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

\n ", "required": true }, "Body": { "shape_name": "Body", "type": "structure", "members": { "Text": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\n

The textual data of the content.

\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\n

The character set of the content.

\n " } }, "documentation": "\n

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile\n devices).\n

\n " }, "Html": { "shape_name": "Content", "type": "structure", "members": { "Data": { "shape_name": "MessageData", "type": "string", "documentation": "\n

The textual data of the content.

\n ", "required": true }, "Charset": { "shape_name": "Charset", "type": "string", "documentation": "\n

The character set of the content.

\n " } }, "documentation": "\n

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted\n text, and much more in an HTML message.\n

\n " } }, "documentation": "\n

The message body.

\n ", "required": true } }, "documentation": "\n

The message to be sent.

\n ", "required": true }, "ReplyToAddresses": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address\n will receive the reply.\n

\n " }, "ReturnPath": { "shape_name": "Address", "type": "string", "documentation": "\n

The email address to which bounce notifications are to be forwarded. If the message cannot be delivered to the\n recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded\n to the email address specified by the\n ReturnPath\n parameter.\n

\n " } }, "documentation": "\n

Represents a request instructing the service to send a single email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, message, reply-to, and return-path\n parts. This object can then be sent using the\n SendEmail\n action.\n

\n " }, "output": { "shape_name": "SendEmailResponse", "type": "structure", "members": { "MessageId": { "shape_name": "MessageId", "type": "string", "documentation": "\n

The unique message identifier returned from the\n SendEmail\n action.\n

\n ", "required": true } }, "documentation": "\n

Represents a unique message ID returned from a successful\n SendEmail\n request.\n

\n " }, "errors": [ { "shape_name": "MessageRejected", "type": "structure", "members": {}, "documentation": "\n Indicates that the action failed, and the message could not be sent. Check the error stack for more\n information about what caused the error.\n " } ], "documentation": "\n

Composes an email message based on input data, and then immediately queues the message\n for sending.\n

\n \n You can only send email from verified email addresses and domains. \n If you have not requested production access to Amazon SES, you must also \n verify every recipient email address except for the recipients provided \n by the Amazon SES mailbox simulator. For more information, go to the\n Amazon SES\n Developer Guide.\n \n

The total size of the message cannot exceed 10 MB.

\n

Amazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n

\n

For every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:25:27 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=yXx/wM1bESLuDErJ6HpZg9JK8Gjau7EUe4FWEfmhodo=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 230\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SendEmail\n&Destination.ToAddresses.member.1=allan%40example.com\n&Message.Body.Text.Data=body\n&Message.Subject.Data=Example&Source=user%40example.com\n&Timestamp=2011-08-18T22%3A25%3A27.000Z\n \n \n \n \n\n \n 00000131d51d2292-159ad6eb-077c-46e6-ad09-ae7c05925ed4-000000\n \n \n d5964849-c866-11e0-9beb-01a62d68c57f\n \n\n \n \n \n " }, "SendRawEmail": { "name": "SendRawEmail", "input": { "shape_name": "SendRawEmailRequest", "type": "structure", "members": { "Source": { "shape_name": "Address", "type": "string", "documentation": "\n

The identity's email address.

\n

\n By default, the string must be 7-bit ASCII. If the text must contain any other characters, \n then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. \n MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. \n For more information, see RFC 2047.\n

\n If you specify the\n Source\n parameter, then bounce notifications and\n complaints will be sent to this email address. This takes precedence over any\n Return-Path\n header that you might include in the raw text of the message.\n \n " }, "Destinations": { "shape_name": "AddressList", "type": "list", "members": { "shape_name": "Address", "type": "string", "documentation": null }, "documentation": "\n

A list of destinations for the message.

\n " }, "RawMessage": { "shape_name": "RawMessage", "type": "structure", "members": { "Data": { "shape_name": "RawMessageData", "type": "blob", "documentation": "\n

The raw data of the message. The client must ensure that the message format complies with Internet email\n standards regarding email header fields, MIME types, MIME encoding, and base64 encoding (if necessary).\n

\n

For more information, go to the Amazon SES Developer Guide.\n

\n ", "required": true } }, "documentation": "\n

The raw text of the message. The client is responsible for ensuring the following:

\n

\n

\n

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to send a raw email message.

\n

This datatype can be used in application code to compose a message consisting of source, destination, and raw message text. This object can\n then be sent using the\n SendRawEmail\n action.\n

\n " }, "output": { "shape_name": "SendRawEmailResponse", "type": "structure", "members": { "MessageId": { "shape_name": "MessageId", "type": "string", "documentation": "\n

The unique message identifier returned from the\n SendRawEmail\n action.\n

\n ", "required": true } }, "documentation": "\n

Represents a unique message ID returned from a successful\n SendRawEmail\n request.\n

\n " }, "errors": [ { "shape_name": "MessageRejected", "type": "structure", "members": {}, "documentation": "\n Indicates that the action failed, and the message could not be sent. Check the error stack for more\n information about what caused the error.\n " } ], "documentation": "\n

Sends an email message, with header and content specified by the client. The\n SendRawEmail\n action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet\n email standards; otherwise, the message cannot be sent.\n

\n \n You can only send email from verified email addresses and domains. \n If you have not requested production access to Amazon SES, you must also \n verify every recipient email address except for the recipients provided \n by the Amazon SES mailbox simulator. For more information, go to the\n Amazon SES\n Developer Guide.\n \n

The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

\n

Amazon SES has a limit on the total number of recipients per message: The combined number\n of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email\n message to a larger audience, you can divide your recipient list into groups of 50 or\n fewer, and then call Amazon SES repeatedly to send the message to each group.\n

\n

For every message that you send, the total number of recipients (To:, CC: and BCC:) is\n counted against your\n sending quota\n - the maximum number of emails you can send in\n a 24-hour period. For information about your sending quota, go to the Amazon SES\n Developer Guide.\n

\n \n \n \nPOST / HTTP/1.1\nDate: Wed, 17 Aug 2011 00:21:38 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=uN0lHIf14tmMBzwnkHzaWBLrBFvJAvyXCsfSYAvwLuc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 230\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SendRawEmail\n&RawMessage.Data=U3ViamVjdDogRXhhbXBsZQpGcm9tOiBleGFtcGxlQGFtYXpvbi5jb20KVG8\n6IGV4YW1wbGVAYW1h%0Aem9uLmNvbQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9hbHRlcm5hdGl2\nZTsgYm91bmRhcnk9MDAx%0ANmU2OGY5ZDkyOWNiMDk2MDRhYWE4MzA0MgoKLS0wMDE2ZTY4ZjlkO\nTI5Y2IwOTYwNGFhYTgzMDQy%0ACkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD1JU0\n8tODg1OS0xCgpCb2R5LgoKLS0w%0AMDE2ZTY4ZjlkOTI5Y2IwOTYwNGFhYTgzMDQyCkNvbnRlbnQ\ntVHlwZTogdGV4dC9odG1sOyBjaGFy%0Ac2V0PUlTTy04ODU5LTEKCkJvZHkuPGJyPgoKLS0wMDE2\nZTY4ZjlkOTI5Y2IwOTYwNGFhYTgzMDQy%0ALS0%3D%0A\n&Timestamp=2011-08-17T00%3A21%3A38.000Z\n \n \n \n \n\n \n 00000131d51d6b36-1d4f9293-0aee-4503-b573-9ae4e70e9e38-000000\n \n \n e0abcdfa-c866-11e0-b6d0-273d09173b49\n \n\n \n \n \n " }, "SetIdentityDkimEnabled": { "name": "SetIdentityDkimEnabled", "input": { "shape_name": "SetIdentityDkimEnabledRequest", "type": "structure", "members": { "Identity": { "shape_name": "Identity", "type": "string", "documentation": "\n

The identity for which DKIM signing should be enabled or disabled.

\n ", "required": true }, "DkimEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\n

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; \n false to disable it.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to enable or disable DKIM signing for an identity.

\n " }, "output": { "shape_name": "SetIdentityDkimEnabledResponse", "type": "structure", "members": {}, "documentation": "\n

An empty element. Receiving this element indicates that the request completed successfully.

\n " }, "errors": [], "documentation": "\n

Enables or disables Easy DKIM signing of email sent from an identity:

\n \n

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the\n corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or \n the VerifyDomainDkim action.

\n

This action is throttled at one request per second.

\n

For more information about Easy DKIM signing, go to the \n Amazon SES Developer Guide.

\n \n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:42:08 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=u/hDNhYm87AV7LAPzouTBz6HJxUEuE5k96sLzYHjR24=, \n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 168\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityDkimEnabled\n&DkimEnabled=true&Identity=user%40example.com\n&Timestamp=2012-06-29T22%3A42%3A08.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n 7aa61362-c469-11e1-aee5-6bbb4608fbcc\n \n\n \n \n \n " }, "SetIdentityFeedbackForwardingEnabled": { "name": "SetIdentityFeedbackForwardingEnabled", "input": { "shape_name": "SetIdentityFeedbackForwardingEnabledRequest", "type": "structure", "members": { "Identity": { "shape_name": "Identity", "type": "string", "documentation": "\n

The identity for which to set feedback notification forwarding. \n Examples: user@example.com, example.com.

\n ", "required": true }, "ForwardingEnabled": { "shape_name": "Enabled", "type": "boolean", "documentation": "\n

Sets whether Amazon SES will forward feedback notifications as email. true specifies \n that Amazon SES will forward feedback notifications as email, in addition to any Amazon SNS topic publishing \n otherwise specified. false specifies that Amazon SES\n will publish feedback notifications only through Amazon SNS. This value can only be \n set to false when topics are specified for both Bounce and \n Complaint topic types.

\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "SetIdentityFeedbackForwardingEnabledResponse", "type": "structure", "members": {}, "documentation": "\n

An empty element. Receiving this element indicates that the request completed successfully.

\n " }, "errors": [], "documentation": "\n

Given an identity (email address or domain), enables or disables whether Amazon SES forwards \n feedback notifications as email. Feedback forwarding may only be disabled when both complaint \n and bounce topics are set.

\n

This action is throttled at one request per second.

\n

For more information about feedback notification, \n see the Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 15 Jun 2012 20:31:21 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=juNpmD6UJaN+r7gcLa2ZNZpO3AmF1ZfOkD6PgxgNhRA=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 188\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityFeedbackForwardingEnabled\n&ForwardingEnabled=true\n&Identity=user%40example.com\n&Timestamp=2012-06-15T20%3A31%3A21.000Z\n&Version=2010-12-01\n\n \n \n \n \n\n \n \n 299f4af4-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n \n " }, "SetIdentityNotificationTopic": { "name": "SetIdentityNotificationTopic", "input": { "shape_name": "SetIdentityNotificationTopicRequest", "type": "structure", "members": { "Identity": { "shape_name": "Identity", "type": "string", "documentation": "\n

The identity for which the topic will be set. Examples: user@example.com, example.com.

\n ", "required": true }, "NotificationType": { "shape_name": "NotificationType", "type": "string", "enum": [ "Bounce", "Complaint" ], "documentation": "\n

The type of feedback notifications that will be published to the specified topic.

\n ", "required": true }, "SnsTopic": { "shape_name": "NotificationTopic", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic. \n If the parameter is omitted from the request or a null value is passed, the topic is cleared and publishing is disabled.

\n " } }, "documentation": "\n

Represents a request to set or clear an identity's notification topic.

\n " }, "output": { "shape_name": "SetIdentityNotificationTopicResponse", "type": "structure", "members": {}, "documentation": "\n

An empty element. Receiving this element indicates that the request completed successfully.

\n " }, "errors": [], "documentation": "\n

Given an identity (email address or domain), sets the Amazon SNS topic to which Amazon SES will publish \n bounce and complaint notifications for emails sent with that identity as the Source. \n Publishing to topics may only be disabled when feedback forwarding is enabled.

\n

This action is throttled at one request per second.

\n

For more information about feedback notification, see the\n Amazon SES Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:27:54 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=3+KQ4VHx991T7Kb41HmFcZJxuHz4/6mf2H5FxY+tuLc=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 203\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=SetIdentityNotificationTopic\n&Identity=user@example.com\n&SnsTopic=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3Aexample\n&NotificationType=Bounce\n&Timestamp=2012-05-12T05%3A27%3A54.000Z&Version=2010-12-01\n \n \n \n \n\n \n \n 299f4af4-b72a-11e1-901f-1fbd90e8104f\n \n\n \n \n \n " }, "VerifyDomainDkim": { "name": "VerifyDomainDkim", "input": { "shape_name": "VerifyDomainDkimRequest", "type": "structure", "members": { "Domain": { "shape_name": "Domain", "type": "string", "documentation": "\n

The name of the domain to be verified for Easy DKIM signing.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to begin DKIM verification for a domain.

\n " }, "output": { "shape_name": "VerifyDomainDkimResponse", "type": "structure", "members": { "DkimTokens": { "shape_name": "VerificationTokenList", "type": "list", "members": { "shape_name": "VerificationToken", "type": "string", "documentation": null }, "documentation": "\n

A set of character strings that represent the domain's identity. If the identity is an\n email address, the tokens represent the domain of that address.

\n

Using these tokens, you will need to create DNS CNAME records that point to DKIM public\n keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have\n updated your DNS records; this detection process may take up to 72 hours. Upon\n successful detection, Amazon SES will be able to DKIM-sign emails originating from that\n domain.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n ", "required": true } }, "documentation": "\n

Represents the DNS records that must be published in the domain name's DNS to complete\n DKIM setup.

\n " }, "errors": [], "documentation": "\n

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that\n represent your domain's identity. Using these tokens, you will need to create DNS CNAME\n records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will\n eventually detect that you have updated your DNS records; this detection process may\n take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign\n email originating from that domain.

\n

This action is throttled at one request per second.

\n

To enable or disable Easy DKIM signing for\n a domain, use the SetIdentityDkimEnabled action.

\n

For more information about creating DNS records using DKIM tokens, go to the Amazon SES\n Developer Guide.

\n \n \n \nPOST / HTTP/1.1\nDate: Fri, 29 Jun 2012 22:43:30 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=roXhd+JhEjeBBo5tSERhrptRHSw4XHz6Ra4BXyHIduk=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 136\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyDomainDkim\n&Domain=example.com\n&Timestamp=2012-06-29T22%3A43%3A30.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6sf\n 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy\n wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2\n \n \n \n 9662c15b-c469-11e1-99d1-797d6ecd6414\n \n\n\n \n \n " }, "VerifyDomainIdentity": { "name": "VerifyDomainIdentity", "input": { "shape_name": "VerifyDomainIdentityRequest", "type": "structure", "members": { "Domain": { "shape_name": "Domain", "type": "string", "documentation": "\n

The domain to be verified.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to begin domain verification.

\n " }, "output": { "shape_name": "VerifyDomainIdentityResponse", "type": "structure", "members": { "VerificationToken": { "shape_name": "VerificationToken", "type": "string", "documentation": "\n

A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.

\n ", "required": true } }, "documentation": "\n

Represents a token used for domain ownership verification.

\n " }, "errors": [], "documentation": "\n

Verifies a domain.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:24:02 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=Wr+6RCfV+QgjLki2dtIrlecMK9+RrsDaTG5uWneDAu8=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 139\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyDomainIdentity\n&Domain=domain.com\n&Timestamp=2012-05-12T05%3A24%3A02.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=\n \n \n 94f6368e-9bf2-11e1-8ee7-c98a0037a2b6\n \n\n \n \n \n " }, "VerifyEmailAddress": { "name": "VerifyEmailAddress", "input": { "shape_name": "VerifyEmailAddressRequest", "type": "structure", "members": { "EmailAddress": { "shape_name": "Address", "type": "string", "documentation": "\n

The email address to be verified.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to begin email address verification.

\n " }, "output": null, "errors": [], "documentation": "\n

Verifies an email address. This action causes a confirmation email message to be \n sent to the specified address.

\n The VerifyEmailAddress action is deprecated as of the May 15, 2012 release\n of Domain Verification. The VerifyEmailIdentity action is now preferred.\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Thu, 18 Aug 2011 22:28:27 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=o9NK68jraFg5BnaTQiQhpxj2x1dGONOEFHHgsM6o5as=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 132\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyEmailAddress\n&EmailAddress=user%40example.com\n&Timestamp=2011-08-18T22%3A28%3A27.000Z\n \n \n \n \n\n \n 8edd7eb2-c864-11e0-9f8f-3da8fc215a7e\n \n\n \n \n \n " }, "VerifyEmailIdentity": { "name": "VerifyEmailIdentity", "input": { "shape_name": "VerifyEmailIdentityRequest", "type": "structure", "members": { "EmailAddress": { "shape_name": "Address", "type": "string", "documentation": "\n

The email address to be verified.

\n ", "required": true } }, "documentation": "\n

Represents a request instructing the service to begin email address verification.

\n " }, "output": { "shape_name": "VerifyEmailIdentityResponse", "type": "structure", "members": {}, "documentation": "\n

An empty element. Receiving this element indicates that the request completed successfully.

\n " }, "errors": [], "documentation": "\n

Verifies an email address. This action causes a confirmation email message\n to be sent to the specified address.

\n

This action is throttled at one request per second.

\n \n \n \nPOST / HTTP/1.1\nDate: Sat, 12 May 2012 05:21:58 GMT\nHost: email.us-east-1.amazonaws.com\nContent-Type: application/x-www-form-urlencoded\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,\n Signature=hQJj2pxypqJHQgU/BW1EZGUiNIYGhkQDf7tI6UgQ2qw=,\n Algorithm=HmacSHA256, SignedHeaders=Date;Host\nContent-Length: 151\n\nAWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Action=VerifyEmailIdentity\n&EmailAddress=user%40domain.com\n&Timestamp=2012-05-12T05%3A21%3A58.000Z\n&Version=2010-12-01\n \n \n \n \n\n \n \n 47e0ef1a-9bf2-11e1-9279-0100e8cf109a\n \n\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null }, "protocols": [ "https", "http" ] }, "pagination": { "ListIdentities": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxItems", "result_key": "Identities", "py_input_token": "next_token" } }, "waiters": { "IdentityExists": { "success": { "path": "VerificationAttributes[].VerificationStatus", "type": "output", "value": [ true ] }, "operation": "GetIdentityVerificationAttributes", "interval": 3, "max_attempts": 20 } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/sns.json0000644000175000017500000046350312254746566017761 0ustar takakitakaki{ "api_version": "2010-03-31", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Simple Notification Service", "service_abbreviation": "Amazon SNS", "endpoint_prefix": "sns", "xmlnamespace": "http://sns.amazonaws.com/doc/2010-03-31/", "documentation": "\n Amazon Simple Notification Service\n \n\t

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. \n \tApplications can use Amazon SNS to easily push real-time notification messages \n \tto interested subscribers over multiple delivery protocols. For more information about this product\n\t\tsee http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls,\n\t\tsee the Amazon SNS Developer Guide.\n\t

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, \n retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services. \n

\n\n ", "operations": { "AddPermission": { "name": "AddPermission", "input": { "shape_name": "AddPermissionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose access control policy you wish to modify.

\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\n

A unique identifier for the new policy statement.

\n ", "required": true }, "AWSAccountId": { "shape_name": "DelegatesList", "type": "list", "members": { "shape_name": "delegate", "type": "string", "documentation": null }, "documentation": "\n

The AWS account IDs of the users (principals) who will be given access to the specified\n actions. The users must have AWS accounts, but do not need to be signed up \n for this service.

\n ", "required": true }, "ActionName": { "shape_name": "ActionsList", "type": "list", "members": { "shape_name": "action", "type": "string", "documentation": null }, "documentation": "\n

The action you want to allow for the specified principal(s).

\n

Valid values: any Amazon SNS action name.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &ActionName.member.1=Publish\n &ActionName.member.2=GetTopicAttributes\n &Label=NewPermission\n &AWSAccountId.member.1=987654321000\n &AWSAccountId.member.2=876543210000\n &Action=AddPermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=k%2FAU%2FKp13pjndwJ7rr1sZszy6MZMlOhRBCHx1ZaZFiw%3D\n\n \n \n \n\n \n 6a213e4e-33a8-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "ConfirmSubscription": { "name": "ConfirmSubscription", "input": { "shape_name": "ConfirmSubscriptionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic for which you wish to confirm a subscription.

\n ", "required": true }, "Token": { "shape_name": "token", "type": "string", "documentation": "\n

Short-lived token sent to an endpoint during the Subscribe action.

\n ", "required": true }, "AuthenticateOnUnsubscribe": { "shape_name": "authenticateOnUnsubscribe", "type": "string", "documentation": "\n

Disallows unauthenticated unsubscribes of the subscription. \n If the value of this parameter is true and the request has an AWS signature, then only the topic owner\n and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires AWS authentication.

\n " } }, "documentation": "\n Input for ConfirmSubscription action.\n " }, "output": { "shape_name": "ConfirmSubscriptionResponse", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the created subscription.

\n " } }, "documentation": "\n Response for ConfirmSubscriptions action.\n " }, "errors": [ { "shape_name": "SubscriptionLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of subscriptions.

\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ConfirmSubscription action verifies an endpoint owner's intent to receive messages by validating\n the token sent to the endpoint by an earlier Subscribe action. If the\n token is valid, the action creates a new subscription and returns its\n Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".

\n\n \n\n https://sns.us-east-1.amazonaws.com/\n ?Action=ConfirmSubscription\n &TopicArn=arn:aws:sns:us-east-1:123456789012:My-Topic\n &Token=51b2ff3edb475b7d91550e0ab6edf0c1de2a34e6ebaf6\n c2262a001bcb7e051c43aa00022ceecce70bd2a67b2042da8d8\n eb47fef7a4e4e942d23e7fa56146b9ee35da040b4b8af564cc4\n 184a7391c834cb75d75c22981f776ad1ce8805e9bab29da2329\n 985337bb8095627907b46c8577c8440556b6f86582a95475802\n 6f41fc62041c4b3f67b0f5921232b5dae5aaca1\n\n \n \n \n\n \n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n \n \n 7a50221f-3774-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "CreatePlatformApplication": { "name": "CreatePlatformApplication", "input": { "shape_name": "CreatePlatformApplicationInput", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\n

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

\n ", "required": true }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\n

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

For a list of attributes, see SetPlatformApplicationAttributes

\n ", "required": true } }, "documentation": "\n

Input for CreatePlatformApplication action.

\n " }, "output": { "shape_name": "CreatePlatformApplicationResponse", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn is returned.

\n " } }, "documentation": "\n

Response from CreatePlatformApplication action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n \n

The CreatePlatformApplication action creates a platform application object for one of the supported push notification services, \n such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using \n the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". \n For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. \n For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". \n The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action.\n For more information, see Using Amazon SNS Mobile Push Notifications. \n

\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.2.key=PlatformPrincipal\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=AIzaSyClE2lcV2zEKTLYYo645zfk2jhQPFeyxDo\n&Attributes.entry.2.value=There+is+no+principal+for+GCM\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Signature=82sHzg1Wfbgisw3i%2BHA2OgBmRktsqUKFinknkq3u%2FQ4%3D\n&Timestamp=2013-07-01T15%3A49%3A50.354Z\n&Name=gcmpushapp\n&Attributes.entry.1.key=PlatformCredential\n&Action=CreatePlatformApplication\n&Version=2010-03-31\n&SignatureVersion=2\n&Platform=GCM\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp\n \n \n b6f0e78b-e9d4-5a0e-b973-adc04e8a4ff9\n \n\n\n \n \n " }, "CreatePlatformEndpoint": { "name": "CreatePlatformEndpoint", "input": { "shape_name": "CreatePlatformEndpointInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

\n ", "required": true }, "Token": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier created by the notification service for an app on a device. \n The specific name for Token will vary, depending on which notification service is being used. \n For example, when using APNS as the notification service, you need the device token. \n Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

\n ", "required": true }, "CustomUserData": { "shape_name": "String", "type": "string", "documentation": "\n

Arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

For a list of attributes, see SetEndpointAttributes.

\n " } }, "documentation": "\n

Input for CreatePlatformEndpoint action.

\n " }, "output": { "shape_name": "CreateEndpointResponse", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn returned from CreateEndpoint action.

\n " } }, "documentation": "\n

Response from CreateEndpoint action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The CreatePlatformEndpoint creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. \n CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is\n returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe \n action for subscription to a topic. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=CreatePlatformEndpoint\n&SignatureMethod=HmacSHA256\n&CustomUserData=UserId%3D27576823\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Token=APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Rg5vXBS6OfgPtWkt1u32p1w14uiGh%2BKOicvXNWTEz2w%3D\n&Timestamp=2013-07-01T15%3A49%3A50.598Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n \n \n 6613341d-3e15-53f7-bf3c-7e56994ba278\n \n\n\n \n \n " }, "CreateTopic": { "name": "CreateTopic", "input": { "shape_name": "CreateTopicInput", "type": "structure", "members": { "Name": { "shape_name": "topicName", "type": "string", "documentation": "\n

The name of the topic you want to create.

\n

Constraints: Topic names must be made up of \n only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be \n between 1 and 256 characters long.

\n ", "required": true } }, "documentation": "\n

Input for CreateTopic action.

\n " }, "output": { "shape_name": "CreateTopicResponse", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The Amazon Resource Name (ARN) assigned to the created topic.

\n " } }, "documentation": "\n

Response from CreateTopic action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "TopicLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of topics.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The CreateTopic action creates a topic to which notifications can be published. Users can create\n at most 100 topics. For more information, see http://aws.amazon.com/sns. \n This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is \n returned without creating a new topic.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Name=My-Topic\n &Action=CreateTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=gfzIF53exFVdpSNb8AiwN3Lv%2FNYXh6S%2Br3yySK70oX4%3D\n\n \n \n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n a8dec8b3-33a4-11df-8963-01868b7c937a\n \n \n \n \n\n " }, "DeleteEndpoint": { "name": "DeleteEndpoint", "input": { "shape_name": "DeleteEndpointInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn of endpoint to delete.

\n ", "required": true } }, "documentation": "\n

Input for DeleteEndpoint action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The DeleteEndpoint action, which is idempotent, deletes the endpoint from SNS. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=DeleteEndpoint\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=LIc6GI3JbNhmHBEDmSxzZp648XPe5CMeFny%2BTQFtomQ%3D\n&Timestamp=2013-07-01T23%3A00%3A12.456Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n c1d2b191-353c-5a5f-8969-fbdd3900afa8\n \n\n\n \n \n " }, "DeletePlatformApplication": { "name": "DeletePlatformApplication", "input": { "shape_name": "DeletePlatformApplicationInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn of platform application object to delete.

\n ", "required": true } }, "documentation": "\n

Input for DeletePlatformApplication action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The DeletePlatformApplication action deletes a platform application object for one of the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=DeletePlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Mh7X%2BQo%2BGpcm5B1IpkovBaRiJCJOqvFlIOYzL62SGrg%3D\n&Timestamp=2013-07-01T23%3A02%3A03.872Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 097dac18-7a77-5823-a8dd-e65476dcb037\n \n\n\n \n \n " }, "DeleteTopic": { "name": "DeleteTopic", "input": { "shape_name": "DeleteTopicInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic you want to delete.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D\n\n \n \n \n\n \n fba800b9-3765-11df-8cf3-c58c53254dfb\n \n\n \n \n\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The DeleteTopic action deletes a topic and all its subscriptions. Deleting a topic might\n prevent some messages previously sent to the topic from being delivered to\n subscribers. This action is idempotent, so deleting a topic that does not\n exist does not result in an error.

\n\n\n\n http://sns.us-east-1.amazonaws.com/\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n\n\n\n\n\n \n f3aa9ac9-3c3d-11df-8235-9dab105e9c32\n \n\n\n\n\n " }, "GetEndpointAttributes": { "name": "GetEndpointAttributes", "input": { "shape_name": "GetEndpointAttributesInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn for GetEndpointAttributes input.

\n ", "required": true } }, "documentation": "\n

Input for GetEndpointAttributes action.

\n " }, "output": { "shape_name": "GetEndpointAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes include the following:

\n \n " } }, "documentation": "\n

Response from GetEndpointAttributes of the EndpointArn.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The GetEndpointAttributes retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=GetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=%2B2egbEoT4npw3p5H3wiIdzZBoTn4KI3UWmMFyBsHH9c%3D\n&Timestamp=2013-07-01T22%3A44%3A56.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n Enabled\n true\n \n \n CustomUserData\n UserId=01234567\n \n \n Token\n APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n \n \n \n \n 6c725a19-a142-5b77-94f9-1055a9ea04e7\n \n\n\n \n \n " }, "GetPlatformApplicationAttributes": { "name": "GetPlatformApplicationAttributes", "input": { "shape_name": "GetPlatformApplicationAttributesInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

\n ", "required": true } }, "documentation": "\n

Input for GetPlatformApplicationAttributes action.

\n " }, "output": { "shape_name": "GetPlatformApplicationAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes include the following:

\n \n " } }, "documentation": "\n

Response for GetPlatformApplicationAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The GetPlatformApplicationAttributes action retrieves the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=GetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=UGMaCq8CCJGSYXO9Ehr2VuHIBYSe6WbxkqgMKRslTK4%3D\n&Timestamp=2013-07-01T22%3A40%3A50.643Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n AllowEndpointPolicies\n false\n \n \n \n \n 74848df2-87f6-55ed-890c-c7be80442462\n \n\n\n \n \n " }, "GetSubscriptionAttributes": { "name": "GetSubscriptionAttributes", "input": { "shape_name": "GetSubscriptionAttributesInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription whose properties you want to get.

\n ", "required": true } }, "documentation": "\n

Input for GetSubscriptionAttributes.

\n " }, "output": { "shape_name": "GetSubscriptionAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "SubscriptionAttributesMap", "type": "map", "keys": { "shape_name": "attributeName", "type": "string", "documentation": null }, "members": { "shape_name": "attributeValue", "type": "string", "documentation": null }, "documentation": "\n

A map of the subscription's attributes. Attributes in this map include the following:

\n \n " } }, "documentation": "\n

Response for GetSubscriptionAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The GetSubscriptionAttribtues action returns all of the properties of a subscription.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=GetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n\n \n \n \n Owner\n 123456789012\n \n \n DeliveryPolicy\n {"healthyRetryPolicy":{"numRetries":10}}\n \n \n SubscriptionArn\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n \n \n \n \n 057f074c-33a7-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "GetTopicAttributes": { "name": "GetTopicAttributes", "input": { "shape_name": "GetTopicAttributesInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose properties you want to get.

\n ", "required": true } }, "documentation": "\n

Input for GetTopicAttributes action.

\n " }, "output": { "shape_name": "GetTopicAttributesResponse", "type": "structure", "members": { "Attributes": { "shape_name": "TopicAttributesMap", "type": "map", "keys": { "shape_name": "attributeName", "type": "string", "documentation": null }, "members": { "shape_name": "attributeValue", "type": "string", "documentation": null }, "documentation": "\n

A map of the topic's attributes. Attributes in this map include the following:

\n \n " } }, "documentation": "\n

Response for GetTopicAttributes action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The GetTopicAttributes action returns all of the properties of a topic. \n Topic properties returned might differ based on the authorization of the user.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=GetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n \n \n \n\n \n \n \n Owner\n 123456789012\n \n \n Policy\n {\n"Version":"2008-10-17","Id":"us-east-1/698519295917/test__default_policy_ID","Statement" : [{"Effect":"Allow","Sid":"us-east-1/698519295917/test__default_statement_ID","Principal" : {"AWS": "*"},"Action":["SNS:GetTopicAttributes","SNS:SetTopicAttributes","SNS:AddPermission","SNS:RemovePermission","SNS:DeleteTopic","SNS:Subscribe","SNS:ListSubscriptionsByTopic","SNS:Publish","SNS:Receive"],"Resource":"arn:aws:sns:us-east-1:698519295917:test","Condition" : {"StringLike" : {"AWS:SourceArn": "arn:aws:*:*:698519295917:*"}}}]}\n \n \n TopicArn\n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n \n \n 057f074c-33a7-11df-9540-99d0768312d3\n \n\n \n \n\n " }, "ListEndpointsByPlatformApplication": { "name": "ListEndpointsByPlatformApplication", "input": { "shape_name": "ListEndpointsByPlatformApplicationInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

\n ", "required": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

\n " } }, "documentation": "\n

Input for ListEndpointsByPlatformApplication action.

\n " }, "output": { "shape_name": "ListEndpointsByPlatformApplicationResponse", "type": "structure", "members": { "Endpoints": { "shape_name": "ListOfEndpoints", "type": "list", "members": { "shape_name": "Endpoint", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn for mobile app and device.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes for endpoint.

\n " } }, "documentation": "\n

Endpoint for mobile app and device.

\n " }, "documentation": "\n

Endpoints returned for ListEndpointsByPlatformApplication action.

\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

\n " } }, "documentation": "\n

Response for ListEndpointsByPlatformApplication action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The ListEndpointsByPlatformApplication action lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. \n The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=ListEndpointsByPlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=e6H4sJSCRBBlh%2BaigB%2FtYgp4%2Bjl7dikAQ6WKf%2BMTwNM%3D\n&Timestamp=2013-07-01T23%3A00%3A52.515Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n \n \n Enabled\n true\n \n \n CustomUserData\n UserId=27576823\n \n \n Token\n APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n \n \n \n \n \n \n 9a48768c-dac8-5a60-aec0-3cc27ea08d96\n \n\n\n \n \n \n " }, "ListPlatformApplications": { "name": "ListPlatformApplications", "input": { "shape_name": "ListPlatformApplicationsInput", "type": "structure", "members": { "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

\n " } }, "documentation": "\n

Input for ListPlatformApplications action.

\n " }, "output": { "shape_name": "ListPlatformApplicationsResponse", "type": "structure", "members": { "PlatformApplications": { "shape_name": "ListOfPlatformApplications", "type": "list", "members": { "shape_name": "PlatformApplication", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for platform application object.

\n " }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Attributes for platform application object.

\n " } }, "documentation": "\n

Platform application object.

\n " }, "documentation": "\n

Platform applications returned when calling ListPlatformApplications action.

\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\n

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

\n " } }, "documentation": "\n

Response for ListPlatformApplications action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListPlatformApplications action lists the platform application objects for the supported push notification services, \n such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n \n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=ListPlatformApplications\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=drVbTuyR5N9e88WJMNPzBOjNFNvawkCaMfZI0xa9kIQ%3D\n&Timestamp=2013-07-01T22%3A33%3A55.618Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n \n \n arn:aws:sns:us-west-2:123456789012:app/APNS_SANDBOX/apnspushapp\n \n \n AllowEndpointPolicies\n false\n \n \n \n \n arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp\n \n \n AllowEndpointPolicies\n false\n \n \n \n \n \n \n 315a335e-85d8-52df-9349-791283cbb529\n \n\n\n \n \n " }, "ListSubscriptions": { "name": "ListSubscriptions", "input": { "shape_name": "ListSubscriptionsInput", "type": "structure", "members": { "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListSubscriptions request.

\n " } }, "documentation": "\n Input for ListSubscriptions action.\n " }, "output": { "shape_name": "ListSubscriptionsResponse", "type": "structure", "members": { "Subscriptions": { "shape_name": "SubscriptionsList", "type": "list", "members": { "shape_name": "Subscription", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The subscription's ARN.

\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\n

The subscription's owner.

\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The subscription's protocol.

\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The subscription's endpoint (format depends on the protocol).

\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the subscription's topic.

\n " } }, "documentation": "

A wrapper type for the attributes of an SNS subscription.

" }, "documentation": "\n

A list of subscriptions.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list\n of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a \n new ListSubscriptions call to get further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n &Action=ListSubscriptions\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:698519295917:My-Topic\n email\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n 123456789012\n example@amazon.com\n \n \n \n \n 384ac68d-3775-11df-8963-01868b7c937a\n \n\n \n \n\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" } }, "ListSubscriptionsByTopic": { "name": "ListSubscriptionsByTopic", "input": { "shape_name": "ListSubscriptionsByTopicInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic for which you wish to find subscriptions.

\n ", "required": true }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListSubscriptionsByTopic request.

\n " } }, "documentation": "\n

Input for ListSubscriptionsByTopic action.

\n " }, "output": { "shape_name": "ListSubscriptionsByTopicResponse", "type": "structure", "members": { "Subscriptions": { "shape_name": "SubscriptionsList", "type": "list", "members": { "shape_name": "Subscription", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The subscription's ARN.

\n " }, "Owner": { "shape_name": "account", "type": "string", "documentation": "\n

The subscription's owner.

\n " }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The subscription's protocol.

\n " }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The subscription's endpoint (format depends on the protocol).

\n " }, "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the subscription's topic.

\n " } }, "documentation": "

A wrapper type for the attributes of an SNS subscription.

" }, "documentation": "\n

A list of subscriptions.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

\n " } }, "documentation": "\n

Response for ListSubscriptionsByTopic action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns \n a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken \n parameter in a new ListSubscriptionsByTopic call to get further results.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=ListSubscriptionsByTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n email\n arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n 123456789012\n example@amazon.com\n \n \n \n \n b9275252-3774-11df-9540-99d0768312d3\n \n\n \n \n \n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" } }, "ListTopics": { "name": "ListTopics", "input": { "shape_name": "ListTopicsInput", "type": "structure", "members": { "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token returned by the previous ListTopics request.

\n " } }, "documentation": null }, "output": { "shape_name": "ListTopicsResponse", "type": "structure", "members": { "Topics": { "shape_name": "TopicsList", "type": "list", "members": { "shape_name": "Topic", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The topic's ARN.

\n " } }, "documentation": "

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

" }, "documentation": "\n

A list of topic ARNs.

\n " }, "NextToken": { "shape_name": "nextToken", "type": "string", "documentation": "\n

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

\n " } }, "documentation": "\n

Response for ListTopics action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If\n there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get \n further results.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?Action=ListTopics\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=tPg1qKNTNVPydnL3Yx5Fqm2O9GxCr9vh3EF5r9%2F5%2BJs%3D\n\n \n \n \n\n \n \n \n arn:aws:sns:us-east-1:123456789012:My-Topic\n \n \n \n \n 3f1478c7-33a9-11df-9540-99d0768312d3\n \n\n \n \n\n ", "pagination": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Topics", "py_input_token": "next_token" } }, "Publish": { "name": "Publish", "input": { "shape_name": "PublishInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The topic you want to publish to.

\n " }, "TargetArn": { "shape_name": "String", "type": "string", "documentation": "\n

Either TopicArn or EndpointArn, but not both.

\n " }, "Message": { "shape_name": "message", "type": "string", "documentation": "\n

The message you want to send to the topic.

\n

If you want to send the same message to all transport protocols,\n include the text of the message as a String value.

\n

If you want to send different messages for each transport protocol,\n set the value of the MessageStructure parameter to json\n and use a JSON object for the Message parameter.\n See the Examples section for the format of the JSON object.

\n

Constraints: Messages must be UTF-8 encoded\n strings at most 256 KB in size (262144 bytes, not 262144 characters).

\n

JSON-specific constraints:\n

\n

\n ", "required": true }, "Subject": { "shape_name": "subject", "type": "string", "documentation": "\n

Optional parameter to be used as the \"Subject\" line when the message is\n delivered to email endpoints. This field will also be included, if present, \n in the standard JSON messages delivered to other endpoints.

\n

Constraints: Subjects must be ASCII text that begins with a letter, number, \n or punctuation mark; must not include line breaks or control characters; and \n must be less than 100 characters long.

\n " }, "MessageStructure": { "shape_name": "messageStructure", "type": "string", "documentation": "\n

Set MessageStructure to json if you want to send\n a different message for each protocol. For example, using one publish action,\n you can send a short message to your SMS subscribers and a longer message to\n your email subscribers.\n If you set MessageStructure to json, the value of \n the Message parameter must:\n

\n \n

You can define other top-level keys that define the message you want to send\n to a specific transport protocol (e.g., \"http\").

\n

For information about sending different messages for each protocol using\n the AWS Management Console, go to Create \n Different Messages for Each Protocol in the Amazon Simple Notification Service\n Getting Started Guide.\n

\n\n

Valid value: json

\n " } }, "documentation": "\n

Input for Publish action.

\n " }, "output": { "shape_name": "PublishResponse", "type": "structure", "members": { "MessageId": { "shape_name": "messageId", "type": "string", "documentation": "\n

Unique identifier assigned to the published message.

\n

Length Constraint: Maximum 100 characters

\n\n " } }, "documentation": "\n

Response for Publish action.

\n " }, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "EndpointDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

Message for endpoint disabled.

\n " } }, "documentation": "\n

Exception error indicating endpoint disabled.

\n " }, { "shape_name": "PlatformApplicationDisabledException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

Message for platform application disabled.

\n " } }, "documentation": "\n

Exception error indicating platform application disabled.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The Publish action sends a message to all of a topic's subscribed endpoints. When a\n messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it \n to the topic's subscribers shortly. The format of the outgoing message to each\n subscribed endpoint depends on the notification protocol selected.

\n

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, \n you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. \n The second example below shows a request and response for publishing to a mobile endpoint.\n

\n \n \n \n The following example publishes the same message to all protocols:\n \n http://sns.us-east-1.amazonaws.com/\n ?Subject=My%20first%20message\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A698519295917%3AMy-Topic\n &Message=Hello%20world%21\n &Action=Publish\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n &Signature=9GZysQ4Jpnz%2BHklqM7VFTvEcjR2LIUtn6jW47054xxE%3D\n \n Use the following JSON object format for the Message parameter to send different messages to each protocol (linebreaks added for readability):\n {\n \"default\" : \"some message\",\n \"email\" : \"some email message\",\n \"email-json\" : \"some email-json message\",\n \"http\" : \"some http message\",\n \"https\" : \"some https message\",\n \"sqs\" : \"some sqs message\"\n }\n \n\n \n \n \n\n \n 94f20ce6-13c5-43a0-9a9e-ca52d816e90b\n \n \n f187a3c1-376f-11df-8963-01868b7c937a\n \n\n \n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=Publish\n&Message=%7B%22default%22%3A%22This+is+the+default+Message%22%2C%22APNS_SANDBOX%22%3A%22%7B+%5C%22aps%5C%22+%3A+%7B+%5C%22alert%5C%22+%3A+%5C%22You+have+got+email.%5C%22%2C+%5C%22badge%5C%22+%3A+9%2C%5C%22sound%5C%22+%3A%5C%22default%5C%22%7D%7D%22%7D\n&TargetArn=arn%3Aaws%3Asns%3Aus-west-2%3A803981987763%3Aendpoint%2FAPNS_SANDBOX%2Fpushapp%2F98e9ced9-f136-3893-9d60-776547eafebb\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=vmqc4XRupKAxsDAdN4j4Ayw5LQljXMps3kss4bkDfCk%3D\n&Timestamp=2013-07-18T22%3A44%3A09.452Z\n&MessageStructure=json\n \n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 567910cd-659e-55d4-8ccb-5aaf14679dc0\n \n \n d74b8436-ae13-5ab4-a9ff-ce54dfea72a0\n \n\n \n \n \n " }, "RemovePermission": { "name": "RemovePermission", "input": { "shape_name": "RemovePermissionInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic whose access control policy you wish to modify.

\n ", "required": true }, "Label": { "shape_name": "label", "type": "string", "documentation": "\n

The unique label of the statement you want to remove.

\n ", "required": true } }, "documentation": "\n

Input for RemovePermission action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The RemovePermission action removes a statement from a topic's access control policy.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &Label=NewPermission\n &Action=RemovePermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=N1abwRY9i7zaSQmbAlm71pPf9EEFOqNbQL1alzw2yCg%3D\n\n \n \n \n\n \n d170b150-33a8-11df-995a-2d6fbe836cc1\n \n\n \n \n\n " }, "SetEndpointAttributes": { "name": "SetEndpointAttributes", "input": { "shape_name": "SetEndpointAttributesInput", "type": "structure", "members": { "EndpointArn": { "shape_name": "String", "type": "string", "documentation": "\n

EndpointArn used for SetEndpointAttributes action.

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A map of the endpoint attributes. Attributes in this map include the following:

\n \n ", "required": true } }, "documentation": "\n

Input for SetEndpointAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The SetEndpointAttributes action sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=CustomUserData\n&Action=SetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=My+custom+userdata\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=CFTGfGOS5vgSU3%2FZgv2h%2FJdWgr2JQdDJSrUU9k38wSM%3D\n&Timestamp=2013-07-01T22%3A56%3A45.582Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n 2fe0bfc7-3e85-5ee5-a9e2-f58b35e85f6a\n \n\n\n \n \n " }, "SetPlatformApplicationAttributes": { "name": "SetPlatformApplicationAttributes", "input": { "shape_name": "SetPlatformApplicationAttributesInput", "type": "structure", "members": { "PlatformApplicationArn": { "shape_name": "String", "type": "string", "documentation": "\n

PlatformApplicationArn for SetPlatformApplicationAttributes action.

\n ", "required": true }, "Attributes": { "shape_name": "MapStringToString", "type": "map", "keys": { "shape_name": "String", "type": "string", "documentation": null }, "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

A map of the platform application attributes. Attributes in this map include the following:

\n \n ", "required": true } }, "documentation": "\n

Input for SetPlatformApplicationAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The SetPlatformApplicationAttributes action sets the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see Using Amazon SNS Mobile Push Notifications.\n

\n \n \n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=EventEndpointCreated&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=SetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atopicarn\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=06L2TsW3jiH%2FGKDYuT8w4NojSrTf4Ig2GKqGeJPhPT4%3D\n&Timestamp=2013-07-01T22%3A53%3A17.800Z\n\n \n \n \nHTTP/1.1 200 OK\n...\n\n \n cf577bcc-b3dc-5463-88f1-3180b9412395\n \n\n\n \n \n " }, "SetSubscriptionAttributes": { "name": "SetSubscriptionAttributes", "input": { "shape_name": "SetSubscriptionAttributesInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription to modify.

\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\n

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

\n

Valid values: DeliveryPolicy

\n ", "required": true }, "AttributeValue": { "shape_name": "attributeValue", "type": "string", "documentation": "\n

The new value for the attribute in JSON format.

\n " } }, "documentation": "\n

Input for SetSubscriptionAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The SetSubscriptionAttributes action allows a subscription owner to set an attribute of the topic to a new value.

\n\n \n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"healthyRetryPolicy\":{\"numRetries\":5}}\n &SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &AttributeName=DeliveryPolicy\n &Action=SetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"healthyRetryPolicy\": \n {\n \"minDelayTarget\": ,\n \"maxDelayTarget\": ,\n \"numRetries\": ,\n \"numMaxDelayRetries\": ,\n \"backoffFunction\": \"\"\n },\n \"throttlePolicy\":\n {\n \"maxReceivesPerSecond\": \n }\n}\n \n \n \n\n \n a8763b99-33a7-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "SetTopicAttributes": { "name": "SetTopicAttributes", "input": { "shape_name": "SetTopicAttributesInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic to modify.

\n ", "required": true }, "AttributeName": { "shape_name": "attributeName", "type": "string", "documentation": "\n

The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

\n

Valid values: Policy | DisplayName | DeliveryPolicy

\n ", "required": true }, "AttributeValue": { "shape_name": "attributeValue", "type": "string", "documentation": "\n

The new value for the attribute.

\n \n\n " } }, "documentation": "\n

Input for SetTopicAttributes action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The SetTopicAttributes action allows a topic owner to set an attribute of the topic to a new value.

\n\n \nThe following example sets the DisplayName attribute to MyTopicName\n\n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue=MyTopicName\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DisplayName\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"http\":{\"defaultHealthyRetryPolicy\":{\"numRetries\":5}}}\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DeliveryPolicy\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D \n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"http\": {\n \"defaultHealthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"disableSubscriptionOverrides\": <boolean>,\n \"defaultThrottlePolicy\": \n {\n \"maxReceivesPerSecond\": <int>\n }\n }\n \n \n \n\n \n a8763b99-33a7-11df-a9b7-05d48da6f042\n \n\n \n \n\n\n\n " }, "Subscribe": { "name": "Subscribe", "input": { "shape_name": "SubscribeInput", "type": "structure", "members": { "TopicArn": { "shape_name": "topicARN", "type": "string", "documentation": "\n

The ARN of the topic you want to subscribe to.

\n ", "required": true }, "Protocol": { "shape_name": "protocol", "type": "string", "documentation": "\n

The protocol you want to use. Supported protocols include:

\n \n ", "required": true }, "Endpoint": { "shape_name": "endpoint", "type": "string", "documentation": "\n

The endpoint that you want to receive notifications. Endpoints vary by protocol:

\n \n ", "py_name": "notification_endpoint", "cli_name": "notification-endpoint", "no_paramfile": true } }, "documentation": "\n Input for Subscribe action.\n " }, "output": { "shape_name": "SubscribeResponse", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription, if the service was able to create a \n subscription immediately (without requiring endpoint owner confirmation).

\n " } }, "documentation": "\n Response for Subscribe action.\n " }, "errors": [ { "shape_name": "SubscriptionLimitExceededException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the customer already owns the maximum allowed number of subscriptions.

\n " }, { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " } ], "documentation": "\n

The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a\n subscription, the endpoint owner must call the ConfirmSubscription\n action with the token from the confirmation message. Confirmation tokens are\n valid for three days.

\n\n \n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Endpoint=example%40amazon.com\n &Protocol=email\n &Action=Subscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=1%2FeGaDphxXq%2Fa89x6HvKh%2Fc1yLGXzuhS7vS2MslToDM%3D\n\n \n \n \n\n \n pending confirmation\n \n \n a169c740-3766-11df-8963-01868b7c937a\n \n\n \n \n\n " }, "Unsubscribe": { "name": "Unsubscribe", "input": { "shape_name": "UnsubscribeInput", "type": "structure", "members": { "SubscriptionArn": { "shape_name": "subscriptionARN", "type": "string", "documentation": "\n

The ARN of the subscription to be deleted.

\n ", "required": true } }, "documentation": "\n

Input for Unsubscribe action.

\n " }, "output": null, "errors": [ { "shape_name": "InvalidParameterException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that a request parameter does not comply with the associated constraints.

\n " }, { "shape_name": "InternalErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates an internal service error.

\n " }, { "shape_name": "AuthorizationErrorException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the user has been denied access to the requested resource.

\n " }, { "shape_name": "NotFoundException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": "\n

Indicates that the requested resource does not exist.

\n " } ], "documentation": "\n

The Unsubscribe action deletes a subscription. If the subscription requires authentication for \n deletion, only the owner of the subscription or the topic's owner \n can unsubscribe, and an AWS signature is required. If the \n Unsubscribe call does not require authentication and the requester is not \n the subscription owner, a final cancellation message is delivered to the \n endpoint, so that the endpoint owner can easily resubscribe to the topic if \n the Unsubscribe request was unintended.

\n \n \n \n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=Unsubscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=e8IwhPzuWeMvPDVrN7jUVxasd3Wv2LuO8x6rE23VCv8%3D\n\n \n \n \n\n \n 18e0ac39-3776-11df-84c0-b93cc1666b84\n \n\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://sns.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "pagination": { "ListSubscriptions": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" }, "ListSubscriptionsByTopic": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions", "py_input_token": "next_token" }, "ListTopics": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Topics", "py_input_token": "next_token" } }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/sqs.json0000644000175000017500000021004012254746566017746 0ustar takakitakaki{ "api_version": "2012-11-05", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "Amazon Simple Queue Service", "service_abbreviation": "Amazon SQS", "endpoint_prefix": "sqs", "xmlnamespace": "http://queue.amazonaws.com/doc/2012-11-05/", "documentation": "\n

Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable,\n hosted queue for storing messages as they travel between computers. By using\n Amazon SQS, developers can simply move data between distributed components of\n their applications that perform different tasks, without losing messages or\n requiring each component to be always available. Amazon SQS makes it easy to\n build an automated workflow, working in close conjunction with the Amazon\n Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web\n services.

\n\n

Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as\n a web service. Any computer on the Internet can add or read messages without\n any installed software or special firewall configurations. Components of\n applications using Amazon SQS can run independently, and do not need to be on\n the same network, developed with the same technologies, or running at the same\n time.

\n\n

Visit http://aws.amazon.com/sqs/\n for more information.

\n ", "operations": { "AddPermission": { "name": "AddPermission", "input": { "shape_name": "AddPermissionRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Label": { "shape_name": "String", "type": "string", "documentation": "\n

The unique identification of the permission you're setting (e.g.,\n AliceSendMessage). Constraints: Maximum 80 characters;\n alphanumeric characters, hyphens (-), and underscores (_) are allowed.

\n ", "required": true }, "AWSAccountIds": { "shape_name": "AWSAccountIdList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "AWSAccountId" }, "flattened": true, "documentation": "\n

The AWS account number of the principal\n who will be given permission. The principal must have an AWS account, but does\n not need to be signed up for Amazon SQS.

\n ", "required": true }, "Actions": { "shape_name": "ActionNameList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ActionName" }, "flattened": true, "documentation": "\n

The action the client wants to allow for the specified principal.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "OverLimit", "type": "structure", "members": {}, "documentation": "\n

The operation that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n

\n " } ], "documentation": "\n

The AddPermission action adds a permission to a queue for a specific \n principal.\n This allows for sharing access to the queue.

\n\n

When you create a queue, you have full control access rights for the queue.\n Only you (as owner of the queue) can grant or deny permissions to the queue.\n For more information about these permissions, see\n Shared\n Queues in the Amazon SQS Developer Guide.

\n\n

AddPermission writes an SQS-generated policy. If you want to\n write your own policy, use SetQueueAttributes to upload your policy. For more\n information about writing your own policy, see\n Appendix:\n The Access Policy Language in the Amazon SQS Developer Guide.

\n " }, "ChangeMessageVisibility": { "name": "ChangeMessageVisibility", "input": { "shape_name": "ChangeMessageVisibilityRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\n

The receipt handle associated with the message whose visibility timeout\n should be changed.

\n ", "required": true }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The new value (in seconds) for the message's visibility timeout.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "MessageNotInflight", "type": "structure", "members": {}, "documentation": "\n

The message referred to is not in flight.

\n " }, { "shape_name": "ReceiptHandleIsInvalid", "type": "structure", "members": {}, "documentation": "\n

The receipt handle provided is not valid.

\n " } ], "documentation": "\n

The ChangeMessageVisibility action changes the visibility\n timeout of a specified message in a queue to a new value. The maximum allowed\n timeout value you can set the value to is 12 hours. This means you can't extend\n the timeout of a message in an existing queue to more than a total visibility\n timeout of 12 hours. (For more information visibility timeout, see Visibility\n Timeout in the Amazon SQS Developer Guide.)

\n\n

For example, let's say you have a message and its default message visibility\n timeout is 30 minutes. You could call ChangeMessageVisiblity with\n a value of two hours and the effective timeout would be two hours and 30\n minutes. When that time comes near you could again extend the time out by\n calling ChangeMessageVisiblity, but this time the maximum allowed timeout would\n be 9 hours and 30 minutes.

\n\n If you attempt to set the VisibilityTimeout to an\n amount more than the maximum time left, Amazon SQS returns an error. It will\n not automatically recalculate and increase the timeout to the maximum time\n remaining.\n\n Unlike with a queue, when you change the visibility timeout for a\n specific message, that timeout value is applied immediately but is not saved in\n memory for that message. If you don't delete a message after it is received,\n the visibility timeout for the message the next time it is received reverts to\n the original timeout value, not the value you set with the\n ChangeMessageVisibility action.\n " }, "ChangeMessageVisibilityBatch": { "name": "ChangeMessageVisibilityBatch", "input": { "shape_name": "ChangeMessageVisibilityBatchRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "ChangeMessageVisibilityBatchRequestEntryList", "type": "list", "members": { "shape_name": "ChangeMessageVisibilityBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

An identifier for this particular receipt handle. This is used to communicate\n the result. Note that the Ids of a batch request need to be\n unique within the request.

\n ", "required": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\n

A receipt handle.

\n ", "required": true }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The new value (in seconds) for the message's visibility timeout.

\n " } }, "documentation": "\n

Encloses a receipt handle and an entry id for each message in\n ChangeMessageVisibilityBatch.

\n ", "xmlname": "ChangeMessageVisibilityBatchRequestEntry" }, "flattened": true, "documentation": "\n

A list of receipt handles of the messages for which the visibility timeout\n must be changed.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ChangeMessageVisibilityBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "ChangeMessageVisibilityBatchResultEntryList", "type": "list", "members": { "shape_name": "ChangeMessageVisibilityBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

Represents a message whose visibility timeout has been changed\n successfully.

\n ", "required": true } }, "documentation": "\n

Encloses the id of an entry in ChangeMessageVisibilityBatch.

\n ", "xmlname": "ChangeMessageVisibilityBatchResultEntry" }, "flattened": true, "documentation": "\n

A list of ChangeMessageVisibilityBatchResultEntrys.

\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

The id of an entry in a batch request.

\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the error happened due to the sender's fault.

\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\n

An error code representing why the operation failed on this entry.

\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

A message explaining why the operation failed on this entry.

\n " } }, "documentation": "\n

This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.

\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\n

A list of BatchResultErrorEntrys.

\n ", "required": true } }, "documentation": null }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request contains more number of entries than permissible.

\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request does not contain an entry.

\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\n

Two or more batch entries have the same Id in the request.

\n " }, { "shape_name": "InvalidBatchEntryId", "type": "structure", "members": {}, "documentation": "\n

The Id of a batch entry in a batch request does not abide\n by the specification.

\n " } ], "documentation": "\n

This is a batch version of ChangeMessageVisibility. It takes\n multiple receipt handles and performs the operation on each of the them. The\n result of the operation on each message is reported individually in the\n response.

\n " }, "CreateQueue": { "name": "CreateQueue", "input": { "shape_name": "CreateQueueRequest", "type": "structure", "members": { "QueueName": { "shape_name": "String", "type": "string", "documentation": "\n

The name for the queue to be created.

\n ", "required": true }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": "\n

The name of a queue attribute.

\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\n

The value of a queue attribute.

\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\n

A map of attributes with their corresponding values.

\n " } }, "documentation": null }, "output": { "shape_name": "CreateQueueResult", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL for the created SQS queue.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "QueueDeletedRecently", "type": "structure", "members": {}, "documentation": "\n

You must wait 60 seconds after deleting a queue before you can create another\n with the same name.

\n " }, { "shape_name": "QueueNameExists", "type": "structure", "members": {}, "documentation": "\n

A queue already exists with this name. SQS returns this error only if the request includes\n attributes whose values differ from those of the existing queue.

\n " } ], "documentation": "\n

The CreateQueue action creates a new queue, or returns the URL\n of an existing one. When you request CreateQueue, you provide a\n name for the queue. To successfully create a new queue, you must provide a name\n that is unique within the scope of your own queues.

\n\n

You may pass one or more attributes in the request. If you do not\n provide a value for any attribute, the queue will have the default value\n for that attribute. Permitted attributes are the same that can be set\n using SetQueueAttributes.

\n\n

If you provide the name of an existing queue, a new queue isn't created.\n If the values of attributes provided with the request match up with those\n on the existing queue, the queue URL is returned. Otherwise, a\n QueueNameExists error is returned.

\n " }, "DeleteMessage": { "name": "DeleteMessage", "input": { "shape_name": "DeleteMessageRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\n

The receipt handle associated with the message to delete.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidIdFormat", "type": "structure", "members": {}, "documentation": "\n

The receipt handle is not valid for the current version.

\n " }, { "shape_name": "ReceiptHandleIsInvalid", "type": "structure", "members": {}, "documentation": "\n

The receipt handle provided is not valid.

\n " } ], "documentation": "\n

The DeleteMessage action unconditionally removes the specified\n message from the specified queue. Even if the message is locked by another\n reader due to the visibility timeout setting, it is still deleted from the\n queue.

\n " }, "DeleteMessageBatch": { "name": "DeleteMessageBatch", "input": { "shape_name": "DeleteMessageBatchRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "DeleteMessageBatchRequestEntryList", "type": "list", "members": { "shape_name": "DeleteMessageBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

An identifier for this particular receipt handle. This is used to\n communicate the result. Note that the Ids of a batch request\n need to be unique within the request.

\n ", "required": true }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": "\n

A receipt handle.

\n ", "required": true } }, "documentation": "\n

Encloses a receipt handle and an identifier for it.

\n ", "xmlname": "DeleteMessageBatchRequestEntry" }, "flattened": true, "documentation": "\n

A list of receipt handles for the messages to be deleted.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteMessageBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "DeleteMessageBatchResultEntryList", "type": "list", "members": { "shape_name": "DeleteMessageBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

Represents a successfully deleted message.

\n ", "required": true } }, "documentation": "\n

Encloses the id an entry in DeleteMessageBatch.

\n ", "xmlname": "DeleteMessageBatchResultEntry" }, "flattened": true, "documentation": "\n

A list of DeleteMessageBatchResultEntrys.

\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

The id of an entry in a batch request.

\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the error happened due to the sender's fault.

\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\n

An error code representing why the operation failed on this entry.

\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

A message explaining why the operation failed on this entry.

\n " } }, "documentation": "\n

This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.

\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\n

A list of BatchResultErrorEntrys.

\n ", "required": true } }, "documentation": null }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request contains more number of entries than permissible.

\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request does not contain an entry.

\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\n

Two or more batch entries have the same Id in the request.

\n " }, { "shape_name": "InvalidBatchEntryId", "type": "structure", "members": {}, "documentation": "\n

The Id of a batch entry in a batch request does not abide\n by the specification.

\n " } ], "documentation": "\n

This is a batch version of DeleteMessage. It takes multiple\n receipt handles and deletes each one of the messages. The result of the delete\n operation on each message is reported individually in the response.

\n " }, "DeleteQueue": { "name": "DeleteQueue", "input": { "shape_name": "DeleteQueueRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

This action unconditionally deletes the queue specified by the queue URL. Use\n this operation WITH CARE! The queue is deleted even if it is NOT empty.

\n

Once a queue has been deleted, the queue name is unavailable for use with new\n queues for 60 seconds.

\n " }, "GetQueueAttributes": { "name": "GetQueueAttributes", "input": { "shape_name": "GetQueueAttributesRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "AttributeNames": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": null, "xmlname": "AttributeName" }, "flattened": true, "documentation": "\n

A list of attributes to retrieve information for.

\n " } }, "documentation": null }, "output": { "shape_name": "GetQueueAttributesResult", "type": "structure", "members": { "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": "\n

The name of a queue attribute.

\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\n

The value of a queue attribute.

\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\n

A map of attributes to the respective values.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidAttributeName", "type": "structure", "members": {}, "documentation": "\n

The attribute referred to does not exist.

\n " } ], "documentation": "\n

Gets attributes for the specified queue. The following attributes are supported:\n

\n

\n " }, "GetQueueUrl": { "name": "GetQueueUrl", "input": { "shape_name": "GetQueueUrlRequest", "type": "structure", "members": { "QueueName": { "shape_name": "String", "type": "string", "documentation": "\n

The name of the queue whose URL must be fetched.

\n ", "required": true }, "QueueOwnerAWSAccountId": { "shape_name": "String", "type": "string", "documentation": "\n

The AWS account number of the queue's owner.

\n " } }, "documentation": null }, "output": { "shape_name": "GetQueueUrlResult", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL for the queue.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "QueueDoesNotExist", "type": "structure", "members": {}, "documentation": "\n

The queue referred to does not exist.

\n " } ], "documentation": "\n

The GetQueueUrl action returns the URL of an existing queue.

\n " }, "ListQueues": { "name": "ListQueues", "input": { "shape_name": "ListQueuesRequest", "type": "structure", "members": { "QueueNamePrefix": { "shape_name": "String", "type": "string", "documentation": "\n

A string to use for filtering the list results. Only those queues whose name\n begins with the specified string are returned.

\n " } }, "documentation": null }, "output": { "shape_name": "ListQueuesResult", "type": "structure", "members": { "QueueUrls": { "shape_name": "QueueUrlList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "QueueUrl" }, "flattened": true, "documentation": "\n

A list of queue URLs, up to 1000 entries.

\n " } }, "documentation": null }, "errors": [], "documentation": "\n

Returns a list of your queues.

\n " }, "ReceiveMessage": { "name": "ReceiveMessage", "input": { "shape_name": "ReceiveMessageRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "AttributeNames": { "shape_name": "AttributeNameList", "type": "list", "members": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": null, "xmlname": "AttributeName" }, "flattened": true, "documentation": "\n

A list of attributes that need to be returned along with each message.\n The set of valid attributes are [SenderId, ApproximateFirstReceiveTimestamp,\n ApproximateReceiveCount, SentTimestamp].\n

\n " }, "MaxNumberOfMessages": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The maximum number of messages to return. Amazon SQS never returns more\n messages than this value but may return fewer.

\n\n

All of the messages are not necessarily returned.

\n " }, "VisibilityTimeout": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The duration (in seconds) that the received messages are hidden from\n subsequent retrieve requests after being retrieved by a\n ReceiveMessage request.

\n " }, "WaitTimeSeconds": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The duration (in seconds) for which the call will wait for a message to arrive\n in the queue before returning. If a message is available, the call will\n return sooner than WaitTimeSeconds.

\n " } }, "documentation": null }, "output": { "shape_name": "ReceiveMessageResult", "type": "structure", "members": { "Messages": { "shape_name": "MessageList", "type": "list", "members": { "shape_name": "Message", "type": "structure", "members": { "MessageId": { "shape_name": "String", "type": "string", "documentation": null }, "ReceiptHandle": { "shape_name": "String", "type": "string", "documentation": null }, "MD5OfBody": { "shape_name": "String", "type": "string", "documentation": null }, "Body": { "shape_name": "String", "type": "string", "documentation": null }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": "\n

The name of a queue attribute.

\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\n

The value of a queue attribute.

\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": null } }, "documentation": null, "xmlname": "Message" }, "flattened": true, "documentation": "\n

A list of messages.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "OverLimit", "type": "structure", "members": {}, "documentation": "\n

The operation that you requested would violate a limit. For example,\n ReceiveMessage returns this error if the maximum number of messages\n inflight has already been reached. AddPermission returns this error if\n the maximum number of permissions for the queue has already been reached.\n

\n " } ], "documentation": "\n

Retrieves one or more messages from the specified queue, including the message\n body and message ID of each message. Messages returned by this action stay in\n the queue until you delete them. However, once a message is returned to a\n ReceiveMessage request, it is not returned on subsequent\n ReceiveMessage requests\n for the duration of the VisibilityTimeout. If you do not specify a\n VisibilityTimeout in the request, the overall visibility timeout for the queue\n is used for the returned messages.

\n\n

If a message is available in the queue, the call will return immediately. Otherwise,\n it will wait up to WaitTimeSeconds for a message to arrive. If you do not specify\n WaitTimeSeconds in the request, the queue attribute\n ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

\n\n

You could ask for additional information about each message through the attributes.\n Attributes that can be requested are [SenderId, ApproximateFirstReceiveTimestamp,\n ApproximateReceiveCount, SentTimestamp].

\n " }, "RemovePermission": { "name": "RemovePermission", "input": { "shape_name": "RemovePermissionRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Label": { "shape_name": "String", "type": "string", "documentation": "\n

The identification of the permission to remove. This is the label added with\n the AddPermission operation.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [], "documentation": "\n

The RemovePermission action revokes any permissions in the queue\n policy that matches the specified Label parameter. Only the owner\n of the queue can remove permissions.

\n " }, "SendMessage": { "name": "SendMessage", "input": { "shape_name": "SendMessageRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "MessageBody": { "shape_name": "String", "type": "string", "documentation": "\n

The message to send.

\n ", "required": true }, "DelaySeconds": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of seconds the message has to be delayed.

\n " } }, "documentation": null }, "output": { "shape_name": "SendMessageResult", "type": "structure", "members": { "MD5OfMessageBody": { "shape_name": "String", "type": "string", "documentation": "\n

An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that SQS received the message correctly. SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://faqs.org/rfcs/rfc1321.html.

\n " }, "MessageId": { "shape_name": "String", "type": "string", "documentation": "\n

The message ID of the message added to the queue.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidMessageContents", "type": "structure", "members": {}, "documentation": "\n

The message contains characters outside the allowed set.

\n " } ], "documentation": "\n

The SendMessage action delivers a message to the specified\n queue.

\n " }, "SendMessageBatch": { "name": "SendMessageBatch", "input": { "shape_name": "SendMessageBatchRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Entries": { "shape_name": "SendMessageBatchRequestEntryList", "type": "list", "members": { "shape_name": "SendMessageBatchRequestEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

An identifier for the message in this batch. This is used to communicate\n the result. Note that the the Ids of a batch request need to\n be unique within the request.

\n ", "required": true }, "MessageBody": { "shape_name": "String", "type": "string", "documentation": "\n

Body of the message.

\n ", "required": true }, "DelaySeconds": { "shape_name": "Integer", "type": "integer", "documentation": "\n

The number of seconds for which the message has to be delayed.

\n " } }, "documentation": "\n

Contains the details of a single SQS message along with a Id.

\n ", "xmlname": "SendMessageBatchRequestEntry" }, "flattened": true, "documentation": "\n

A list of SendMessageBatchRequestEntrys.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "SendMessageBatchResult", "type": "structure", "members": { "Successful": { "shape_name": "SendMessageBatchResultEntryList", "type": "list", "members": { "shape_name": "SendMessageBatchResultEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

An identifier for the message in this batch.

\n ", "required": true }, "MessageId": { "shape_name": "String", "type": "string", "documentation": "\n

An identifier for the message.

\n ", "required": true }, "MD5OfMessageBody": { "shape_name": "String", "type": "string", "documentation": "\n

An MD5 digest of the non-URL-encoded message body string. This can be used to\n verify that SQS received the message correctly. SQS first URL decodes the\n message before creating the MD5 digest. For information about MD5, go to http://faqs.org/rfcs/rfc1321.html.

\n ", "required": true } }, "documentation": "\n

Encloses a message ID for successfully enqueued message of a\n SendMessageBatch.

\n ", "xmlname": "SendMessageBatchResultEntry" }, "flattened": true, "documentation": "\n

A list of SendMessageBatchResultEntrys.

\n ", "required": true }, "Failed": { "shape_name": "BatchResultErrorEntryList", "type": "list", "members": { "shape_name": "BatchResultErrorEntry", "type": "structure", "members": { "Id": { "shape_name": "String", "type": "string", "documentation": "\n

The id of an entry in a batch request.

\n ", "required": true }, "SenderFault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Whether the error happened due to the sender's fault.

\n ", "required": true }, "Code": { "shape_name": "String", "type": "string", "documentation": "\n

An error code representing why the operation failed on this entry.

\n ", "required": true }, "Message": { "shape_name": "String", "type": "string", "documentation": "\n

A message explaining why the operation failed on this entry.

\n " } }, "documentation": "\n

This is used in the responses of batch API to give a detailed description\n of the result of an operation on each entry in the request.

\n ", "xmlname": "BatchResultErrorEntry" }, "flattened": true, "documentation": "\n

A list of BatchResultErrorEntrys with the error detail about each\n message that could not be enqueued.

\n ", "required": true } }, "documentation": null }, "errors": [ { "shape_name": "TooManyEntriesInBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request contains more number of entries than permissible.

\n " }, { "shape_name": "EmptyBatchRequest", "type": "structure", "members": {}, "documentation": "\n

Batch request does not contain an entry.

\n " }, { "shape_name": "BatchEntryIdsNotDistinct", "type": "structure", "members": {}, "documentation": "\n

Two or more batch entries have the same Id in the request.

\n " }, { "shape_name": "BatchRequestTooLong", "type": "structure", "members": {}, "documentation": "\n

The length of all the messages put together is more than the limit.

\n " }, { "shape_name": "InvalidBatchEntryId", "type": "structure", "members": {}, "documentation": "\n

The Id of a batch entry in a batch request does not abide\n by the specification.

\n " } ], "documentation": "\n

This is a batch version of SendMessage. It takes\n multiple messages and adds each of them to the queue. The result of each \n add operation is reported individually in the response.

\n " }, "SetQueueAttributes": { "name": "SetQueueAttributes", "input": { "shape_name": "SetQueueAttributesRequest", "type": "structure", "members": { "QueueUrl": { "shape_name": "String", "type": "string", "documentation": "\n

The URL of the SQS queue to take action on.

\n ", "required": true, "no_paramfile": true }, "Attributes": { "shape_name": "AttributeMap", "type": "map", "keys": { "shape_name": "QueueAttributeName", "type": "string", "enum": [ "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds" ], "documentation": "\n

The name of a queue attribute.

\n ", "xmlname": "Name" }, "members": { "shape_name": "String", "type": "string", "documentation": "\n

The value of a queue attribute.

\n ", "xmlname": "Value" }, "flattened": true, "xmlname": "Attribute", "documentation": "\n

A map of attributes to set.

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "InvalidAttributeName", "type": "structure", "members": {}, "documentation": "\n

The attribute referred to does not exist.

\n " } ], "documentation": "\n

Sets the value of one or more queue attributes. Valid attributes that\n can be set are [VisibilityTimeout, Policy, MaximumMessageSize,\n MessageRetentionPeriod, ReceiveMessageWaitTimeSeconds].

\n " } }, "metadata": { "regions": { "us-east-1": "https://queue.amazonaws.com/", "ap-northeast-1": "https://ap-northeast-1.queue.amazonaws.com/", "sa-east-1": "https://sa-east-1.queue.amazonaws.com/", "ap-southeast-1": "https://ap-southeast-1.queue.amazonaws.com/", "ap-southeast-2": "https://ap-southeast-2.queue.amazonaws.com/", "us-west-2": "https://us-west-2.queue.amazonaws.com/", "us-west-1": "https://us-west-1.queue.amazonaws.com/", "eu-west-1": "https://eu-west-1.queue.amazonaws.com/", "us-gov-west-1": null, "cn-north-1": "https://sqs.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https", "http" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "RequestThrottled", "http_status_code": 403 } } } } } } }botocore-0.29.0/botocore/data/aws/storagegateway.json0000644000175000017500000302154712254746566022205 0ustar takakitakaki{ "api_version": "2013-06-30", "type": "json", "json_version": 1.1, "target_prefix": "StorageGateway_20130630", "signature_version": "v4", "service_full_name": "AWS Storage Gateway", "endpoint_prefix": "storagegateway", "xmlnamespace": "http://storagegateway.amazonaws.com/doc/2013-06-30", "documentation": "\n AWS Storage Gateway Service\n\n

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to\n provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage\n infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and\n rapid disaster recovery.

\n\n

Use the following links to get started using the AWS Storage Gateway Service API Reference:

\n \n ", "operations": { "ActivateGateway": { "name": "ActivateGateway", "input": { "shape_name": "ActivateGatewayInput", "type": "structure", "members": { "ActivationKey": { "shape_name": "ActivationKey", "type": "string", "min_length": 1, "max_length": 50, "documentation": "\n

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects\n enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key\n for your gateway in the query string parameter activationKey. It may also\n include other activation-related parameters, however, these are merely\n defaults -- the arguments you pass to the ActivateGateway API call\n determine the actual configuration of your gateway.

\n ", "required": true }, "GatewayName": { "shape_name": "GatewayName", "type": "string", "min_length": 2, "max_length": 255, "pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", "documentation": "\n

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which\n is what you use as an input to other operations.

\n ", "required": true }, "GatewayTimezone": { "shape_name": "GatewayTimezone", "type": "string", "min_length": 3, "max_length": 10, "documentation": "\n

One of the values that indicates the time zone you want to set for the gateway. The time\n zone is used, for example, for scheduling snapshots and your gateway's maintenance\n schedule.

\n ", "required": true }, "GatewayRegion": { "shape_name": "RegionId", "type": "string", "min_length": 1, "max_length": 25, "documentation": "\n

One of the values that indicates the region where you want to store the snapshot\n backups. The gateway region specified must be the same region as the\n region in your Host header in the request. For more information about available regions \n and endpoints for AWS Storage Gateway, see Regions and Endpoints in\n the Amazon Web Services Glossary.

\n

Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"ap-northeast-1\", \"ap-southest-1\",\n \"sa-east-1\"

\n ", "required": true }, "GatewayType": { "shape_name": "GatewayType", "type": "string", "min_length": 2, "max_length": 20, "documentation": "\n

One of the values that defines the type of gateway to activate. The type specified is\n critical to all later functions of the gateway and cannot be changed after activation. The\n default value is STORED.

\n " } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "ActivateGatewayOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of\n information such as your account, gateway name, and region. This ARN is\n used to reference the gateway in other API operations as well as\n resource-based authorization.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation activates the gateway you previously deployed on your host. For more\n information, see Downloading \n and Deploying AWS Storage Gateway VM. In the activation process you\n specify information such as the region you want to use for storing snapshots, the time zone\n for scheduled snapshots and the gateway schedule window, an activation key, and a name for\n your gateway. The activation process also associates your gateway with your account (see UpdateGatewayInformation).

\n You must power on the gateway VM before you can activate your gateway.\n \n \n Example Request\n The following example shows a request that activates a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ActivateGateway\n{\n \"ActivationKey\": \"29AV1-3OFV9-VVIUB-NKT0I-LRO6V\",\n \"GatewayName\": \"mygateway\",\n \"GatewayTimezone\": \"GMT-12:00\",\n \"GatewayRegion\": \"us-east-1\",\n \"GatewayType\": \"STORED\"\n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n \n " }, "AddCache": { "name": "AddCache", "input": { "shape_name": "AddCacheInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "AddCacheOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation configures one or more gateway local disks as cache for a cached-volume\n gateway. This operation is supported only for the gateway-cached volume architecture (see\n Storage Gateway Concepts).

\n

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and \n one or more disk IDs that you want to configure as cache.

\n \n \n Example Request\n The following example shows a request that activates a gateway.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120425T120000Z\nx-amz-target: StorageGateway_20120630.AddCache\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [ \n \"pci-0000:03:00.0-scsi-0:0:0:0\", \n \"pci-0000:03:00.0-scsi-0:0:1:0\"\n ] \n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 85\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n \n " }, "AddUploadBuffer": { "name": "AddUploadBuffer", "input": { "shape_name": "AddUploadBufferInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "AddUploadBufferOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation configures one or more gateway local disks as upload buffer for a specified gateway. \n This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n

\n

\n In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer,\n and one or more disk IDs that you want to configure as upload buffer.

\n " }, "AddWorkingStorage": { "name": "AddWorkingStorage", "input": { "shape_name": "AddWorkingStorageInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": "\n

An array of strings that identify disks that are to be configured as working storage. Each string have a\n minimum length of 1 and maximum length of 300. You can get the disk IDs from\n the ListLocalDisks API.

\n ", "required": true } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "AddWorkingStorageOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway for which working storage was configured.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation configures one or more gateway local disks as working storage for a gateway. \n This operation is supported only for the gateway-stored volume architecture.

\n

Working storage is also referred to as upload buffer. You can also use the \n AddUploadBuffer operation to add upload buffer to a stored-volume gateway.

\n

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage,\n and one or more disk IDs that you want to configure as working storage.

\n \n \n Example Request\n The following example shows a request that specifies that two local disks of a gateway are to\n be configured as working storage.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.AddWorkingStorage\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:04:00.0-scsi-1:0:0:0\"]\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n\n \n \n \n " }, "CancelArchival": { "name": "CancelArchival", "input": { "shape_name": "CancelArchivalInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CancelArchivalOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "CancelRetrieval": { "name": "CancelRetrieval", "input": { "shape_name": "CancelRetrievalInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CancelRetrievalOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "CreateCachediSCSIVolume": { "name": "CreateCachediSCSIVolume", "input": { "shape_name": "CreateCachediSCSIVolumeInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "VolumeSizeInBytes": { "shape_name": "long", "type": "long", "documentation": null, "required": true }, "SnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": null }, "TargetName": { "shape_name": "TargetName", "type": "string", "min_length": 1, "max_length": 200, "pattern": "^[-\\.;a-z0-9]+$", "documentation": null, "required": true }, "NetworkInterfaceId": { "shape_name": "NetworkInterfaceId", "type": "string", "pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z", "documentation": null, "required": true }, "ClientToken": { "shape_name": "ClientToken", "type": "string", "min_length": 5, "max_length": 100, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CreateCachediSCSIVolumeOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation creates a cached volume on a specified cached gateway. This operation is\n supported only for the gateway-cached volume architecture.

\n Cache storage must be allocated to the gateway before you can create a cached volume.\n Use the AddCache operation to add cache storage to a gateway. \n

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI\n target name, an IP address on which to expose the target, and a unique client token. In\n response, AWS Storage Gateway creates the volume and returns information about it such\n as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that\n initiators can use to connect to the volume target.

\n \n \n Example Request\n The following example shows a request that specifies that a local disk of a gateway be\n configured as a cached volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateCachediSCSIVolume\n{\n \"ClientToken\": \"cachedvol112233\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"NetworkInterfaceId\": \"10.1.1.1\",\n \"TargetName\": \"myvolume\",\n \"VolumeSizeInBytes\": 536870912000\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 263\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \n \n " }, "CreateSnapshot": { "name": "CreateSnapshot", "input": { "shape_name": "CreateSnapshotInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

\n ", "required": true }, "SnapshotDescription": { "shape_name": "SnapshotDescription", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot\n Details pane, Description field

\n ", "required": true } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "CreateSnapshotOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

\n " }, "SnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": "\n

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot\n (CreateStorediSCSIVolume).

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation initiates a snapshot of a volume.

\n

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple\n Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS)\n volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or\n ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working\n With Snapshots in the AWS Storage Gateway Console.

\n

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must\n also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the\n snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns\n you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to\n create a volume from a snapshot.

\n To list or delete a snapshot, you must use the Amazon EC2 API. For more information, .\n \n \n Example Request\n The following example sends a CreateSnapshot request to take snapshot of the\n specified an example volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateSnapshot\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 128\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotId\": \"snap-78e22663\"\n}\n \n \n \n " }, "CreateSnapshotFromVolumeRecoveryPoint": { "name": "CreateSnapshotFromVolumeRecoveryPoint", "input": { "shape_name": "CreateSnapshotFromVolumeRecoveryPointInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true }, "SnapshotDescription": { "shape_name": "SnapshotDescription", "type": "string", "min_length": 1, "max_length": 255, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CreateSnapshotFromVolumeRecoveryPointOutput", "type": "structure", "members": { "SnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": null }, "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "VolumeRecoveryPointTime": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture (see ).

\n

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for gateway-cached volumes, \n use ListVolumeRecoveryPoints.

\n

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When AWS Storage Gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

\n \n

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

\n \n \n \n Example Request\n The following example sends a\n CreateSnapshotFromVolumeRecoveryPoint request to take snapshot of the\n specified an example volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.CreateSnapshotFromVolumeRecoveryPoint\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"SnapshotDescription\": \"snapshot description\"\n}\n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"SnapshotId\": \"snap-78e22663\",\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-06-30T10:10:10.000Z\" \n} \n\n \n \n \n " }, "CreateStorediSCSIVolume": { "name": "CreateStorediSCSIVolume", "input": { "shape_name": "CreateStorediSCSIVolumeInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "DiskId": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": "\n

The unique identifier for the gateway local disk that is configured as a stored volume. Use\n ListLocalDisks to list disk IDs for a gateway.

\n ", "required": true }, "SnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": "\n

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field\n if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list\n snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

\n " }, "PreserveExistingData": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field\n as false creates an empty volume.

\n

Valid Values: true, false

\n ", "required": true }, "TargetName": { "shape_name": "TargetName", "type": "string", "min_length": 1, "max_length": 200, "pattern": "^[-\\.;a-z0-9]+$", "documentation": "\n

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.\n For example, specifying TargetName as myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The\n target name must be unique across all volumes of a gateway.

\n ", "required": true }, "NetworkInterfaceId": { "shape_name": "NetworkInterfaceId", "type": "string", "pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z", "documentation": "\n

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use\n DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

\n

Valid Values: A valid IP address.

\n ", "required": true } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "CreateStorediSCSIVolumeOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the configured volume.

\n " }, "VolumeSizeInBytes": { "shape_name": "long", "type": "long", "documentation": "\n

The size of the volume in bytes.

\n " }, "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to\n connect to the target.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation creates a volume on a specified gateway. This operation is supported only for the gateway-cached volume architecture.\n

\n

The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

\n

In the request you must specify the gateway and the disk information on which you are creating the volume. In response, AWS Storage Gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

\n \n \n Example Request\n The following example shows a request that specifies that a local disk of a gateway be\n configured as a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.CreateStorediSCSIVolume\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"PreserveExistingData\": true,\n \"TargetName\": \"myvolume\",\n \"NetworkInterfaceId\": \"10.1.1.1\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 215\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n \n \n \n " }, "CreateTapes": { "name": "CreateTapes", "input": { "shape_name": "CreateTapesInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "TapeSizeInBytes": { "shape_name": "TapeSize", "type": "long", "min_length": 107374182400, "max_length": 5497558138880, "documentation": null, "required": true }, "ClientToken": { "shape_name": "ClientToken", "type": "string", "min_length": 5, "max_length": 100, "documentation": null, "required": true }, "NumTapesToCreate": { "shape_name": "NumTapesToCreate", "type": "integer", "min_length": 1, "max_length": 10, "documentation": null, "required": true }, "TapeBarcodePrefix": { "shape_name": "TapeBarcodePrefix", "type": "string", "min_length": 0, "max_length": 4, "pattern": "[A-Z0-9]*", "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "CreateTapesOutput", "type": "structure", "members": { "TapeARNs": { "shape_name": "TapeARNs", "type": "list", "members": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DeleteBandwidthRateLimit": { "name": "DeleteBandwidthRateLimit", "input": { "shape_name": "DeleteBandwidthRateLimitInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "BandwidthType": { "shape_name": "BandwidthType", "type": "string", "min_length": 3, "max_length": 25, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteBandwidthRateLimitOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation deletes the bandwidth rate limits of a gateway. You can delete either the upload and download\n bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains\n unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your\n request.

\n \n \n Example Request\n The following example shows a request that deletes both of the bandwidth rate limits of a\n gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"BandwidthType: \"All\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "DeleteChapCredentials": { "name": "DeleteChapCredentials", "input": { "shape_name": "DeleteChapCredentialsInput", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

\n ", "required": true }, "InitiatorName": { "shape_name": "IqnName", "type": "string", "min_length": 1, "max_length": 255, "pattern": "[0-9a-z:.-]+", "documentation": "\n

The iSCSI initiator that connects to the target.

\n ", "required": true } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "DeleteChapCredentialsOutput", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the target.

\n " }, "InitiatorName": { "shape_name": "IqnName", "type": "string", "min_length": 1, "max_length": 255, "pattern": "[0-9a-z:.-]+", "documentation": "\n

The iSCSI initiator that connects to the target.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target and initiator pair.

\n \n \n Example Request\n The following example shows a request that deletes the CHAP credentials for an iSCSI target\n myvolume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \n \n " }, "DeleteGateway": { "name": "DeleteGateway", "input": { "shape_name": "DeleteGatewayInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway to delete.

\n " }, "output": { "shape_name": "DeleteGatewayOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the deleted gateway.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the\n gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual\n machine (VM) from your host computer.

\n

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not\n deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway,\n your next step is to remove it from your environment.

\n \n

You no longer pay software charges after the gateway is deleted; however, your existing\n Amazon EBS snapshots persist and you will continue to be billed for these\n snapshots.\u00a0You can choose to remove all remaining Amazon EBS snapshots by\n canceling your Amazon EC2 subscription.\u00a0 If you prefer not to cancel your Amazon\n EC2 subscription, you can delete your snapshots using the Amazon EC2 console.\n For more information, see the \n AWS Storage Gateway Detail Page.

\n \n \n \n Example Request\n The following example shows a request that deactivates a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "DeleteSnapshotSchedule": { "name": "DeleteSnapshotSchedule", "input": { "shape_name": "DeleteSnapshotScheduleInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteSnapshotScheduleOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

\n This operation deletes a snapshot of a volume.\n

\n

\n You can take snapshots of your gateway volumes on a scheduled or ad-hoc basis. This API\n enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). \n

\n \n

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API\n Reference.

\n \n \n \n Example Request\n The following example...\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DeleteSnapshotSchedule\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n} \n\n \n \n \n " }, "DeleteTape": { "name": "DeleteTape", "input": { "shape_name": "DeleteTapeInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteTapeOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DeleteTapeArchive": { "name": "DeleteTapeArchive", "input": { "shape_name": "DeleteTapeArchiveInput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "DeleteTapeArchiveOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DeleteVolume": { "name": "DeleteVolume", "input": { "shape_name": "DeleteVolumeInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

\n " }, "output": { "shape_name": "DeleteVolumeOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the\n request.

\n " } }, "documentation": "\n

A JSON object containing the of the storage volume that was deleted

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation delete the specified gateway volume that you previously created using the\n CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage\n volume is not deleted. You can reuse the local disk to create another storage volume.

\n

Before you delete a gateway volume, make sure there are no iSCSI connections to the volume\n you are deleting. You should also make sure there is no snapshot in progress. You can\n use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume\n you are deleting and check the snapshot status. For more information, go\n to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

\n

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

\n \n \n Example Request\n The following example shows a request that deletes a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DeleteVolume\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \n \n " }, "DescribeBandwidthRateLimit": { "name": "DescribeBandwidthRateLimit", "input": { "shape_name": "DescribeBandwidthRateLimitInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway.

\n " }, "output": { "shape_name": "DescribeBandwidthRateLimitOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "AverageUploadRateLimitInBitsPerSec": { "shape_name": "BandwidthUploadRateLimit", "type": "long", "min_length": 51200, "documentation": "\n

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the\n upload rate limit is not set.

\n " }, "AverageDownloadRateLimitInBitsPerSec": { "shape_name": "BandwidthDownloadRateLimit", "type": "long", "min_length": 102400, "documentation": "\n

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the\n download rate limit is not set.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n \n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns the bandwidth rate limits of a gateway. By default, these limits are not set, which\n means no bandwidth rate limiting is in effect.

\n

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set\n for the gateway, then this operation returns only the gateway ARN in the response body. To specify which\n gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that returns the bandwidth throttle properties of a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygate way\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 169\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 102400,\n \"AverageDownloadRateLimitInBitsPerSec\": 51200\n}\n \n \n \n " }, "DescribeCache": { "name": "DescribeCache", "input": { "shape_name": "DescribeCacheInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeCacheOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": null }, "CacheAllocatedInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "CacheUsedPercentage": { "shape_name": "double", "type": "double", "documentation": null }, "CacheDirtyPercentage": { "shape_name": "double", "type": "double", "documentation": null }, "CacheHitPercentage": { "shape_name": "double", "type": "double", "documentation": null }, "CacheMissPercentage": { "shape_name": "double", "type": "double", "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns information about the cache of a gateway. \n This operation is supported only for the gateway-cached volume architecture.\n

\n

\n The response includes disk IDs that are configured as cache, and it \n includes the amount of cache allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's\n working storage.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCache\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"CacheAllocationInBytes\": 2199023255552,\n \"CacheDirtyPercentage\": 0.07,\n \"CacheHitPercentage\": 99.68,\n \"CacheMissPercentage\": 0.32,\n \"CacheUsedPercentage\": 0.07,\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \n \n " }, "DescribeCachediSCSIVolumes": { "name": "DescribeCachediSCSIVolumes", "input": { "shape_name": "DescribeCachediSCSIVolumesInput", "type": "structure", "members": { "VolumeARNs": { "shape_name": "VolumeARNs", "type": "list", "members": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": null, "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeCachediSCSIVolumesOutput", "type": "structure", "members": { "CachediSCSIVolumes": { "shape_name": "CachediSCSIVolumes", "type": "list", "members": { "shape_name": "CachediSCSIVolumeInformation", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "VolumeId": { "shape_name": "VolumeId", "type": "string", "min_length": 12, "max_length": 30, "documentation": null }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "min_length": 3, "max_length": 100, "documentation": null }, "VolumeStatus": { "shape_name": "VolumeStatus", "type": "string", "min_length": 3, "max_length": 50, "documentation": null }, "VolumeSizeInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "VolumeProgress": { "shape_name": "DoubleObject", "type": "double", "documentation": null }, "SourceSnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": null }, "VolumeiSCSIAttributes": { "shape_name": "VolumeiSCSIAttributes", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the volume target.

\n " }, "NetworkInterfaceId": { "shape_name": "NetworkInterfaceId", "type": "string", "pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z", "documentation": "\n

The network interface identifier.

\n " }, "NetworkInterfacePort": { "shape_name": "integer", "type": "integer", "documentation": "\n

The port used to communicate with iSCSI targets.

\n " }, "LunNumber": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": "\n

The logical disk number.

\n " }, "ChapEnabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

Indicates whether mutual CHAP is enabled for the iSCSI target.

\n " } }, "documentation": "\n

Lists iSCSI information about a volume.

\n " } }, "documentation": null }, "documentation": "\n

An array of objects where each object contains metadata about one cached volume.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n \n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns a description of the gateway volumes specified in the request. \n This operation is supported only for the gateway-cached volume architecture.

\n

\n The list of gateway volumes in the request must be from one gateway. \n In the response Amazon Storage Gateway returns volume information sorted by volume \n Amazon Resource Name (ARN).

\n \n \n Example Request\n The following example shows a request that returns a description of a volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeCachediSCSIVolumes\n\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 664\n\n{\n \"CachediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\": {\n \"ChapEnabled\": true,\n \"LunNumber\": 0,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"AVAILABLE\",\n \"VolumeType\": \"CACHED iSCSI\"\n }\n ]\n} \n\n \n \n \n " }, "DescribeChapCredentials": { "name": "DescribeChapCredentials", "input": { "shape_name": "DescribeChapCredentialsInput", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

\n " }, "output": { "shape_name": "DescribeChapCredentialsOutput", "type": "structure", "members": { "ChapCredentials": { "shape_name": "ChapCredentials", "type": "list", "members": { "shape_name": "ChapInfo", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the volume.

\n

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

\n " }, "SecretToAuthenticateInitiator": { "shape_name": "ChapSecret", "type": "string", "min_length": 12, "max_length": 16, "documentation": "\n

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the target.

\n " }, "InitiatorName": { "shape_name": "IqnName", "type": "string", "min_length": 1, "max_length": 255, "pattern": "[0-9a-z:.-]+", "documentation": "\n

The iSCSI initiator that connects to the target.

\n " }, "SecretToAuthenticateTarget": { "shape_name": "ChapSecret", "type": "string", "min_length": 12, "max_length": 16, "documentation": "\n

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).

\n " } }, "documentation": "\n

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between\n your gateway and iSCSI initiators.

\n " }, "documentation": "\n

An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

\n \n " } }, "documentation": "\n

A JSON object containing a .

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information\n for a specified iSCSI target, one for each target-initiator pair.

\n \n \n Example Request\n The following example shows a request that returns the CHAP credentials of an iSCSI\n target.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 235\n{\n \"ChapCredentials\": {\n \"TargetName\": \"iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n }\n}\n \n \n \n " }, "DescribeGatewayInformation": { "name": "DescribeGatewayInformation", "input": { "shape_name": "DescribeGatewayInformationInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway.

\n " }, "output": { "shape_name": "DescribeGatewayInformationOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "GatewayId": { "shape_name": "GatewayId", "type": "string", "min_length": 12, "max_length": 30, "documentation": "\n

The gateway ID.

\n " }, "GatewayTimezone": { "shape_name": "GatewayTimezone", "type": "string", "min_length": 3, "max_length": 10, "documentation": "\n

One of the values that indicates the time zone configured for the gateway.

\n " }, "GatewayState": { "shape_name": "GatewayState", "type": "string", "min_length": 2, "max_length": 25, "documentation": "\n

One of the values that indicates the operating state of the gateway.

\n " }, "GatewayNetworkInterfaces": { "shape_name": "GatewayNetworkInterfaces", "type": "list", "members": { "shape_name": "NetworkInterface", "type": "structure", "members": { "Ipv4Address": { "shape_name": "string", "type": "string", "documentation": "\n

The Internet Protocol version 4 (IPv4) address of the interface.

\n " }, "MacAddress": { "shape_name": "string", "type": "string", "documentation": "\n

The Media Access Control (MAC) address of the interface.

\n This is currently unsupported and will not be returned in output.\n " }, "Ipv6Address": { "shape_name": "string", "type": "string", "documentation": "\n

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

\n " } }, "documentation": "\n

Describes a gateway's network interface.

\n " }, "documentation": "\n

A NetworkInterface array that contains descriptions of the gateway network interfaces.

\n " }, "GatewayType": { "shape_name": "GatewayType", "type": "string", "min_length": 2, "max_length": 20, "documentation": "\n

TBD

\n " }, "NextUpdateAvailabilityDate": { "shape_name": "NextUpdateAvailabilityDate", "type": "string", "min_length": 1, "max_length": 25, "documentation": "\n

The date at which an update to the gateway is available. This date is in the time zone of the gateway. If the\n gateway is not available for an update this field is not returned in the response.

\n \n " } }, "documentation": "\n

A JSON object containing the following fields:

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and\n the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon\n Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request for describing a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 227\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayId\": \"sgw-AABB1122\",\n \"GatewayNetworkInterfaces\": [ {\"Ipv4Address\": \"10.35.69.216\"} ],\n \"GatewayState\": \"STATE_RUNNING\",\n \"GatewayTimezone\": \"GMT-8:00\"\n}\n \n \n \n " }, "DescribeMaintenanceStartTime": { "name": "DescribeMaintenanceStartTime", "input": { "shape_name": "DescribeMaintenanceStartTimeInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway.

\n " }, "output": { "shape_name": "DescribeMaintenanceStartTimeOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "HourOfDay": { "shape_name": "HourOfDay", "type": "integer", "min_length": 0, "max_length": 23, "documentation": null }, "MinuteOfHour": { "shape_name": "MinuteOfHour", "type": "integer", "min_length": 0, "max_length": 59, "documentation": null }, "DayOfWeek": { "shape_name": "DayOfWeek", "type": "integer", "min_length": 0, "max_length": 6, "documentation": null }, "Timezone": { "shape_name": "GatewayTimezone", "type": "string", "min_length": 3, "max_length": 10, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns your gateway's weekly maintenance start time including the day and time of the week.\n Note that values are in terms of the gateway's time zone.

\n \n \n Example Request\n The following example shows a request that describes a gateway's maintenance\n window.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 136\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 15,\n \"MinuteOfHour\": 35,\n \"DayOfWeek\": 2,\n \"Timezone\": \"GMT+7:00\"\n}\n \n \n \n " }, "DescribeSnapshotSchedule": { "name": "DescribeSnapshotSchedule", "input": { "shape_name": "DescribeSnapshotScheduleInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway\n volumes.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

\n " }, "output": { "shape_name": "DescribeSnapshotScheduleOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "StartAt": { "shape_name": "HourOfDay", "type": "integer", "min_length": 0, "max_length": 23, "documentation": null }, "RecurrenceInHours": { "shape_name": "RecurrenceInHours", "type": "integer", "min_length": 1, "max_length": 24, "documentation": null }, "Description": { "shape_name": "Description", "type": "string", "min_length": 1, "max_length": 255, "documentation": null }, "Timezone": { "shape_name": "GatewayTimezone", "type": "string", "min_length": 3, "max_length": 10, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation describes the snapshot schedule for the specified gateway volume. The snapshot schedule\n information includes intervals at which snapshots are automatically initiated on the volume.

\n \n \n Example Request\n The following example shows a request that retrieves the snapshot schedule for a\n volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 211\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 6,\n \"RecurrenceInHours\": 24,\n \"Description\": \"sgw-AABB1122:vol-AABB1122:Schedule\",\n \"Timezone\": \"GMT+7:00\"\n}\n \n \n \n " }, "DescribeStorediSCSIVolumes": { "name": "DescribeStorediSCSIVolumes", "input": { "shape_name": "DescribeStorediSCSIVolumesInput", "type": "structure", "members": { "VolumeARNs": { "shape_name": "VolumeARNs", "type": "list", "members": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": "\n

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the\n specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a\n gateway.

\n ", "required": true } }, "documentation": "\n

A JSON Object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

\n " }, "output": { "shape_name": "DescribeStorediSCSIVolumesOutput", "type": "structure", "members": { "StorediSCSIVolumes": { "shape_name": "StorediSCSIVolumes", "type": "list", "members": { "shape_name": "StorediSCSIVolumeInformation", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "VolumeId": { "shape_name": "VolumeId", "type": "string", "min_length": 12, "max_length": 30, "documentation": null }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "min_length": 3, "max_length": 100, "documentation": null }, "VolumeStatus": { "shape_name": "VolumeStatus", "type": "string", "min_length": 3, "max_length": 50, "documentation": null }, "VolumeSizeInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "VolumeProgress": { "shape_name": "DoubleObject", "type": "double", "documentation": null }, "VolumeDiskId": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "SourceSnapshotId": { "shape_name": "SnapshotId", "type": "string", "pattern": "\\Asnap-[0-9a-fA-F]{8}\\z", "documentation": null }, "PreservedExistingData": { "shape_name": "boolean", "type": "boolean", "documentation": null }, "VolumeiSCSIAttributes": { "shape_name": "VolumeiSCSIAttributes", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the volume target.

\n " }, "NetworkInterfaceId": { "shape_name": "NetworkInterfaceId", "type": "string", "pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z", "documentation": "\n

The network interface identifier.

\n " }, "NetworkInterfacePort": { "shape_name": "integer", "type": "integer", "documentation": "\n

The port used to communicate with iSCSI targets.

\n " }, "LunNumber": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": "\n

The logical disk number.

\n " }, "ChapEnabled": { "shape_name": "boolean", "type": "boolean", "documentation": "\n

Indicates whether mutual CHAP is enabled for the iSCSI target.

\n " } }, "documentation": "\n

Lists iSCSI information about a volume.

\n " } }, "documentation": null }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns description of the gateway volumes specified in the request. The list of gateway volumes\n in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information\n sorted by volume ARNs.

\n \n \n Example Request\n The following example shows a request that returns a description of a volume.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeStorediSCSIVolumes\n{\n \"VolumeARNs\": [\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"]\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 507\n{\n \"StorediSCSIVolumes\": [\n {\n \"VolumeiSCSIAttributes\":\n {\n \"ChapEnabled\": true,\n \"NetworkInterfaceId\": \"10.243.43.207\",\n \"NetworkInterfacePort\": 3260,\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\"\n },\n \"PreservedExistingData\": false,\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/myg\n ateway/volume/vol-1122AABB\",\n \"VolumeDiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"VolumeId\": \"vol-1122AABB\",\n \"VolumeProgress\": 23.7,\n \"VolumeSizeInBytes\": 1099511627776,\n \"VolumeStatus\": \"BOOTSTRAPPING\"\n }\n ]\n}\n \n \n \n " }, "DescribeTapeArchives": { "name": "DescribeTapeArchives", "input": { "shape_name": "DescribeTapeArchivesInput", "type": "structure", "members": { "TapeARNs": { "shape_name": "TapeARNs", "type": "list", "members": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeTapeArchivesOutput", "type": "structure", "members": { "TapeArchives": { "shape_name": "TapeArchives", "type": "list", "members": { "shape_name": "TapeArchive", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "TapeBarcode": { "shape_name": "TapeBarcode", "type": "string", "min_length": 8, "max_length": 16, "pattern": "[A-Z0-9]*", "documentation": null }, "TapeSizeInBytes": { "shape_name": "TapeSize", "type": "long", "min_length": 107374182400, "max_length": 5497558138880, "documentation": null }, "CompletionTime": { "shape_name": "Time", "type": "timestamp", "documentation": null }, "RetrievedTo": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "TapeStatus": { "shape_name": "TapeArchiveStatus", "type": "string", "documentation": null } }, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DescribeTapeRecoveryPoints": { "name": "DescribeTapeRecoveryPoints", "input": { "shape_name": "DescribeTapeRecoveryPointsInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeTapeRecoveryPointsOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "TapeRecoveryPointInfos": { "shape_name": "TapeRecoveryPointInfos", "type": "list", "members": { "shape_name": "TapeRecoveryPointInfo", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "TapeRecoveryPointTime": { "shape_name": "Time", "type": "timestamp", "documentation": null }, "TapeSizeInBytes": { "shape_name": "TapeSize", "type": "long", "min_length": 107374182400, "max_length": 5497558138880, "documentation": null } }, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DescribeTapes": { "name": "DescribeTapes", "input": { "shape_name": "DescribeTapesInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "TapeARNs": { "shape_name": "TapeARNs", "type": "list", "members": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeTapesOutput", "type": "structure", "members": { "Tapes": { "shape_name": "Tapes", "type": "list", "members": { "shape_name": "Tape", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "TapeBarcode": { "shape_name": "TapeBarcode", "type": "string", "min_length": 8, "max_length": 16, "pattern": "[A-Z0-9]*", "documentation": null }, "TapeSizeInBytes": { "shape_name": "TapeSize", "type": "long", "min_length": 107374182400, "max_length": 5497558138880, "documentation": null }, "TapeStatus": { "shape_name": "TapeStatus", "type": "string", "documentation": null }, "VTLDevice": { "shape_name": "VTLDeviceARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "Progress": { "shape_name": "DoubleObject", "type": "double", "documentation": null } }, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DescribeUploadBuffer": { "name": "DescribeUploadBuffer", "input": { "shape_name": "DescribeUploadBufferInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DescribeUploadBufferOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": null }, "UploadBufferUsedInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "UploadBufferAllocatedInBytes": { "shape_name": "long", "type": "long", "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.\n

\n

\n The response includes disk IDs that are configured as upload buffer space, and it includes\n the amount of upload buffer space allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's\n working storage.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.DescribeUploadBuffer\n\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 271\n\n{\n \"DiskIds\": [\n \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"pci-0000:04:00.0-scsi-0:1:0:0\"\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"UploadBufferAllocatedInBytes\": 161061273600,\n \"UploadBufferUsedInBytes\": 0\n} \n\n \n \n \n " }, "DescribeVTLDevices": { "name": "DescribeVTLDevices", "input": { "shape_name": "DescribeVTLDevicesInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "VTLDeviceARNs": { "shape_name": "VTLDeviceARNs", "type": "list", "members": { "shape_name": "VTLDeviceARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": null } }, "documentation": null }, "output": { "shape_name": "DescribeVTLDevicesOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "VTLDevices": { "shape_name": "VTLDevices", "type": "list", "members": { "shape_name": "VTLDevice", "type": "structure", "members": { "VTLDeviceARN": { "shape_name": "VTLDeviceARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "DeviceiSCSIAttributes": { "shape_name": "DeviceiSCSIAttributes", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": null }, "NetworkInterfaceId": { "shape_name": "NetworkInterfaceId", "type": "string", "pattern": "\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z", "documentation": null }, "NetworkInterfacePort": { "shape_name": "integer", "type": "integer", "documentation": null }, "ChapEnabled": { "shape_name": "boolean", "type": "boolean", "documentation": null } }, "documentation": null } }, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "DescribeWorkingStorage": { "name": "DescribeWorkingStorage", "input": { "shape_name": "DescribeWorkingStorageInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway.

\n " }, "output": { "shape_name": "DescribeWorkingStorageOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "DiskIds": { "shape_name": "DiskIds", "type": "list", "members": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "documentation": "\n

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is\n specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as\n working storage, then the DiskIds array is empty.

\n " }, "WorkingStorageUsedInBytes": { "shape_name": "long", "type": "long", "documentation": "\n

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway,\n this field returns 0.

\n " }, "WorkingStorageAllocatedInBytes": { "shape_name": "long", "type": "long", "documentation": "\n

The total working storage in bytes allocated for the gateway. If no working storage is configured for the\n gateway, this field returns 0.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n \n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture.

\n

Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored-volume gateway.

\n

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

\n \n \n Example Request\n The following example shows a request to obtain a description of a gateway's working\n storage.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.DescribeWorkingStorage\n{\n \"GatewayARN\":\"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 241\n{\n \"DiskIds\": [\"pci-0000:03:00.0-scsi-0:0:0:0\", \"pci-0000:03:00.0-scsi-0:0:1:0\"],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"WorkingStorageAllocatedInBytes\": 2199023255552,\n \"WorkingStorageUsedInBytes\": 789207040\n}\n \n \n \n " }, "DisableGateway": { "name": "DisableGateway", "input": { "shape_name": "DisableGatewayInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DisableGatewayOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "ListGateways": { "name": "ListGateways", "input": { "shape_name": "ListGatewaysInput", "type": "structure", "members": { "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": "\n

An opaque string that indicates the position at which to begin the returned list of gateways.

\n " }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": "\n

Specifies that the list of gateways returned be limited to the specified number of items.

\n " } }, "documentation": "\n

A JSON object containing zero or more of the following fields:

\n \n " }, "output": { "shape_name": "ListGatewaysOutput", "type": "structure", "members": { "Gateways": { "shape_name": "Gateways", "type": "list", "members": { "shape_name": "GatewayInformation", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "GatewayType": { "shape_name": "GatewayType", "type": "string", "min_length": 2, "max_length": 20, "documentation": null } }, "documentation": null }, "documentation": null }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation lists gateways owned by an AWS account in a region specified in the request. The returned list\n is ordered by gateway Amazon Resource Name (ARN).

\n

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you\n to optionally reduce the number of gateways returned in a response.

\n

If you have more gateways than are returned in a response-that is, the response returns only a truncated list\n of your gateways-the response contains a marker that you can specify in your next request to fetch the next\n page of gateways.

\n \n \n List Gateways\n The following example does not specify any criteria for the returned list. Note that the\n request body is \"{}\". The response returns gateways (or up to the first 100) in the\n specified region owned by the AWS account.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListGateways\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 178\n{\n \"GatewayList\": [\n {\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n }\n ]\n}\n \n \n \n " }, "ListLocalDisks": { "name": "ListLocalDisks", "input": { "shape_name": "ListLocalDisksInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway.

\n " }, "output": { "shape_name": "ListLocalDisksOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "Disks": { "shape_name": "Disks", "type": "list", "members": { "shape_name": "DiskInformation", "type": "structure", "members": { "DiskId": { "shape_name": "DiskId", "type": "string", "min_length": 1, "max_length": 300, "documentation": null }, "DiskPath": { "shape_name": "string", "type": "string", "documentation": null }, "DiskNode": { "shape_name": "string", "type": "string", "documentation": null }, "DiskSizeInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "DiskAllocationType": { "shape_name": "DiskAllocationType", "type": "string", "min_length": 3, "max_length": 100, "documentation": null }, "DiskAllocationResource": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation returns a list of the local disks of a gateway. To specify which gateway to describe you use the\n Amazon Resource Name (ARN) of the gateway in the body of the request.

\n

The request returns all disks, specifying which are configured as working storage, stored volume or not\n configured at all.

\n \n \n Example Request\n The following example shows a request that returns information about a gateway's local\n disks.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListLocalDisks\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 398\n{\n \"Disks\": [\n {\n \"DiskAllocationType\": \"UPLOAD_BUFFER\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:0:0\",\n \"DiskNode\": \"SCSI(0:0)\",\n \"DiskPath\": \"/dev/sda\",\n \"DiskSizeInBytes\": 1099511627776\n },\n {\n \"DiskAllocationType\": \"STORED_iSCSI_VOLUME\",\n \"DiskAllocationResource\": \"\",\n \"DiskId\": \"pci-0000:03:00.0-scsi-0:0:1:0\",\n \"DiskNode\": \"SCSI(0:1)\",\n \"DiskPath\": \"/dev/sdb\",\n \"DiskSizeInBytes\": 1099511627776\n }\n ],\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "ListVolumeRecoveryPoints": { "name": "ListVolumeRecoveryPoints", "input": { "shape_name": "ListVolumeRecoveryPointsInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ListVolumeRecoveryPointsOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "VolumeRecoveryPointInfos": { "shape_name": "VolumeRecoveryPointInfos", "type": "list", "members": { "shape_name": "VolumeRecoveryPointInfo", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "VolumeSizeInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "VolumeUsageInBytes": { "shape_name": "long", "type": "long", "documentation": null }, "VolumeRecoveryPointTime": { "shape_name": "string", "type": "string", "documentation": null } }, "documentation": null }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.

\n

Each gateway-cached volume has one recovery point. A volume recovery point is a point \n in time at which all data of the volume is consistent and from which you can create a snapshot. \n To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

\n \n \n Example Request\n The following example sends a ListVolumeRecoveryPoints request to take a\n snapshot of the specified example volume.\n \nPOST / HTTP/1.1 \nHost: storagegateway.us-east-1.amazonaws.com\nContent-Type: application/x-amz-json-1.1\nAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2\nx-amz-date: 20120912T120000Z\nx-amz-target: StorageGateway_20120630.ListVolumeRecoveryPoints\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0\nDate: Wed, 12 Sep 2012 12:00:02 GMT\nContent-Type: application/x-amz-json-1.1\nContent-length: 137\n\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeRecoveryPointInfos\": [ \n { \n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeRecoveryPointTime\": \"2012-09-04T21:08:44.627Z\",\n \"VolumeSizeInBytes\": 536870912000,\n \"VolumeUsageInBytes\": 6694048\n } \n ] \n} \n\n \n \n \n " }, "ListVolumes": { "name": "ListVolumes", "input": { "shape_name": "ListVolumesInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": "\n

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the\n response of a previous List iSCSI Volumes request.

\n " }, "Limit": { "shape_name": "PositiveIntObject", "type": "integer", "min_length": 1, "documentation": "\n

Specifies that the list of volumes returned be limited to the specified number of items.

\n " } }, "documentation": "\n

A JSON object that contains one or more of the following fields:

\n \n " }, "output": { "shape_name": "ListVolumesOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " }, "Marker": { "shape_name": "Marker", "type": "string", "min_length": 1, "max_length": 1000, "documentation": null }, "VolumeInfos": { "shape_name": "VolumeInfos", "type": "list", "members": { "shape_name": "VolumeInformation", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "min_length": 3, "max_length": 100, "documentation": null } }, "documentation": null }, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response\n includes only the volume ARNs. If you want additional volume information, use the\n DescribeStorediSCSIVolumes API.

\n

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can\n optionally specify the Limit field in the body to limit the number of volumes in the response. If\n the number of volumes returned in the response is truncated, the response includes a Marker field. You can use\n this Marker value in your subsequent request to retrieve the next set of volumes.

\n \n \n Example Request\n The List iSCSI Volumes request in this example does not specify a limit or\n marker field in the response body. The response returns the volumes\n (up to the first 100) of the gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ListVolumes\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 346\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"VolumeInfos\": [\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"VolumeType\": \"STORED\"\n },\n {\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-3344CCDD\",\n \"VolumeType\": \"STORED\"\n },\n ]\n}\n \n \n \n " }, "RetrieveTapeArchive": { "name": "RetrieveTapeArchive", "input": { "shape_name": "RetrieveTapeArchiveInput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true }, "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RetrieveTapeArchiveOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "RetrieveTapeRecoveryPoint": { "name": "RetrieveTapeRecoveryPoint", "input": { "shape_name": "RetrieveTapeRecoveryPointInput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null, "required": true }, "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "RetrieveTapeRecoveryPointOutput", "type": "structure", "members": { "TapeARN": { "shape_name": "TapeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": null } }, "documentation": null }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": null }, "ShutdownGateway": { "name": "ShutdownGateway", "input": { "shape_name": "ShutdownGatewayInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway to shut down.

\n " }, "output": { "shape_name": "ShutdownGatewayOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway that was shut down.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN)\n of the gateway in the body of your request.

\n

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM)\n and not the VM.

\n If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM\n to avoid unpredictable conditions.\n

After the gateway is shutdown, you cannot call any other API except StartGateway,\n DescribeGatewayInformation, and ListGateways. For more information, see\n ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there\n are no snapshots taken.

\n When you make a shutdown request, you will get a 200 OK success response immediately. However,\n it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to\n check the status. For more information, see ActivateGateway.\n

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay\n software charges associated with the gateway.

\n \n \n Example Request\n The following example shows a request that shuts down a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.ShutdownGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "StartGateway": { "name": "StartGateway", "input": { "shape_name": "StartGatewayInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway to start.

\n " }, "output": { "shape_name": "StartGatewayOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway that was restarted.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation starts a gateway that you previously shut down (see ShutdownGateway). After the gateway\n starts, you can then make other API calls, your applications can read from or write to the gateway's storage\n volumes and you will be able to take snapshot backups.

\n When you make a request, you will get a 200 OK success response immediately. However, it might take some\n time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before\n making any additional API calls. For more information, see ActivateGateway.\n

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that starts a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.StartGateway\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "UpdateBandwidthRateLimit": { "name": "UpdateBandwidthRateLimit", "input": { "shape_name": "UpdateBandwidthRateLimitInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "AverageUploadRateLimitInBitsPerSec": { "shape_name": "BandwidthUploadRateLimit", "type": "long", "min_length": 51200, "documentation": "\n

The average upload bandwidth rate limit in bits per second.

\n " }, "AverageDownloadRateLimitInBitsPerSec": { "shape_name": "BandwidthDownloadRateLimit", "type": "long", "min_length": 102400, "documentation": "\n

The average download bandwidth rate limit in bits per second.

\n " } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "UpdateBandwidthRateLimitOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway whose throttle information was updated.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates the bandwidth rate limits of a gateway. You can update both the upload and download\n bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate\n limit remains.

\n

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not\n have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

\n

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that returns the bandwidth throttle properties of a\n gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateBandwidthRateLimit\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"AverageUploadRateLimitInBitsPerSec\": 51200,\n \"AverageDownloadRateLimitInBitsPerSec\": 102400\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "UpdateChapCredentials": { "name": "UpdateChapCredentials", "input": { "shape_name": "UpdateChapCredentialsInput", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation\n to return to retrieve the TargetARN for specified VolumeARN.

\n ", "required": true }, "SecretToAuthenticateInitiator": { "shape_name": "ChapSecret", "type": "string", "min_length": 12, "max_length": 16, "documentation": "\n

The secret key that the initiator (e.g. Windows client) must provide to participate in mutual CHAP with the\n target.

\n ", "required": true }, "InitiatorName": { "shape_name": "IqnName", "type": "string", "min_length": 1, "max_length": 255, "pattern": "[0-9a-z:.-]+", "documentation": "\n

The iSCSI initiator that connects to the target.

\n ", "required": true }, "SecretToAuthenticateTarget": { "shape_name": "ChapSecret", "type": "string", "min_length": 12, "max_length": 16, "documentation": "\n

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows\n client).

\n " } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "UpdateChapCredentialsOutput", "type": "structure", "members": { "TargetARN": { "shape_name": "TargetARN", "type": "string", "min_length": 50, "max_length": 800, "documentation": "\n

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

\n " }, "InitiatorName": { "shape_name": "IqnName", "type": "string", "min_length": 1, "max_length": 255, "pattern": "[0-9a-z:.-]+", "documentation": "\n

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

\n " } }, "documentation": "\n

A JSON object containing the following fields:

\n \n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI\n target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

\n \n

When you update CHAP credentials, all existing connections on the target are\n closed and initiators must reconnect with the new credentials.

\n \n \n \n \n Example Request\n The following example shows a request that updates CHAP credentials for an iSCSI\n target.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateChapCredentials\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"SecretToAuthenticateInitiator\": \"111111111111\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\",\n \"SecretToAuthenticateTarget\": \"222222222222\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 161\n{\n \"TargetARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume\",\n \"InitiatorName\": \"iqn.1991-05.com.microsoft:computername.domain.example.com\"\n}\n \n \n \n " }, "UpdateGatewayInformation": { "name": "UpdateGatewayInformation", "input": { "shape_name": "UpdateGatewayInformationInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "GatewayName": { "shape_name": "GatewayName", "type": "string", "min_length": 2, "max_length": 255, "pattern": "^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$", "documentation": "\n

A unique identifier for your gateway. This name becomes part of the gateway Amazon Resources Name (ARN) which\n is what you use as an input to other operations.

\n " }, "GatewayTimezone": { "shape_name": "GatewayTimezone", "type": "string", "min_length": 3, "max_length": 10, "documentation": null } }, "documentation": null }, "output": { "shape_name": "UpdateGatewayInformationOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway that was updated.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates a gateway's metadata, which includes the gateway's name and time zone. To specify which\n gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

\n \n \n Example Request\n The following example shows a request that updates the name of a gateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewayInformation\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"GatewayName\" \"mygateway2\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 81\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway2\"\n}\n \n \n \n " }, "UpdateGatewaySoftwareNow": { "name": "UpdateGatewaySoftwareNow", "input": { "shape_name": "UpdateGatewaySoftwareNowInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway to update.

\n " }, "output": { "shape_name": "UpdateGatewaySoftwareNowOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n " } }, "documentation": "\n

A JSON object containing the of the gateway that was updated.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates the gateway virtual machine (VM) software. The request immediately triggers the software\n update.

\n When you make this request, you get a 200 OK success response immediately. However, it might\n take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway\n is in the STATE_RUNNING state.\n A software update forces a system restart of your gateway. You can minimize the chance of any disruption to\n your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI\n Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.\n \n \n Example Request\n The following example shows a request that initiates a gateway VM update.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateGatewaySoftwareNow\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n}\n \n \n \n " }, "UpdateMaintenanceStartTime": { "name": "UpdateMaintenanceStartTime", "input": { "shape_name": "UpdateMaintenanceStartTimeInput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true }, "HourOfDay": { "shape_name": "HourOfDay", "type": "integer", "min_length": 0, "max_length": 23, "documentation": "\n

The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

\n ", "required": true }, "MinuteOfHour": { "shape_name": "MinuteOfHour", "type": "integer", "min_length": 0, "max_length": 59, "documentation": "\n

The minute component of the maintenance start time represented as mm, where mm is the minute\n (00 to 59). The minute of the hour is in the time zone of the gateway.

\n ", "required": true }, "DayOfWeek": { "shape_name": "DayOfWeek", "type": "integer", "min_length": 0, "max_length": 6, "documentation": "\n

The maintenance start time day of the week.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the following fields:

\n \n " }, "output": { "shape_name": "UpdateMaintenanceStartTimeOutput", "type": "structure", "members": { "GatewayARN": { "shape_name": "GatewayARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of\n gateways for your account and region.

\n ", "required": true } }, "documentation": "\n

A JSON object containing the of the gateway whose maintenance start time is updated.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates a gateway's weekly maintenance start time information, including day and time of the\n week. The maintenance time is the time in your gateway's time zone.

\n \n \n Example Request\n The following example shows a request that updates the maintenance start time of\n mygateway.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateMaintenanceStartTime\n{\n \"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\",\n \"HourOfDay\": 0,\n \"MinuteOfHour\": 30,\n \"DayOfWeek\": 2\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 80\n{\n\"GatewayARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway\"\n} \n \n \n " }, "UpdateSnapshotSchedule": { "name": "UpdateSnapshotSchedule", "input": { "shape_name": "UpdateSnapshotScheduleInput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway\n volumes.

\n ", "required": true }, "StartAt": { "shape_name": "HourOfDay", "type": "integer", "min_length": 0, "max_length": 23, "documentation": "\n

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour\n (0 to 23). The hour of the day is in the time zone of the gateway.

\n ", "required": true }, "RecurrenceInHours": { "shape_name": "RecurrenceInHours", "type": "integer", "min_length": 1, "max_length": 24, "documentation": "\n

Frequency of snapshots. Specify the number of hours between snapshots.

\n ", "required": true }, "Description": { "shape_name": "Description", "type": "string", "min_length": 1, "max_length": 255, "documentation": "\n

Optional description of the snapshot that overwrites the existing description.

\n " } }, "documentation": "\n

A JSON object containing one or more of the following fields:

\n \n " }, "output": { "shape_name": "UpdateSnapshotScheduleOutput", "type": "structure", "members": { "VolumeARN": { "shape_name": "VolumeARN", "type": "string", "min_length": 50, "max_length": 500, "documentation": "\n " } }, "documentation": "\n

A JSON object containing the of the updated storage volume.

\n " }, "errors": [ { "shape_name": "InvalidGatewayRequestException", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An exception occured because an invalid gateway request was issued to the service. See the error and message\n fields for more information.

\n " }, { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "string", "type": "string", "documentation": "\n

A human-readable message describing the error that occured.

\n " }, "error": { "shape_name": "StorageGatewayError", "type": "structure", "members": { "errorCode": { "shape_name": "ErrorCode", "type": "string", "enum": [ "ActivationKeyExpired", "ActivationKeyInvalid", "ActivationKeyNotFound", "GatewayInternalError", "GatewayNotConnected", "GatewayNotFound", "GatewayProxyNetworkConnectionBusy", "AuthenticationFailure", "BandwidthThrottleScheduleNotFound", "Blocked", "CannotExportSnapshot", "ChapCredentialNotFound", "DiskAlreadyAllocated", "DiskDoesNotExist", "DiskSizeGreaterThanVolumeMaxSize", "DiskSizeLessThanVolumeSize", "DiskSizeNotGigAligned", "DuplicateCertificateInfo", "DuplicateSchedule", "EndpointNotFound", "IAMNotSupported", "InitiatorInvalid", "InitiatorNotFound", "InternalError", "InvalidGateway", "InvalidEndpoint", "InvalidParameters", "InvalidSchedule", "LocalStorageLimitExceeded", "LunAlreadyAllocated ", "LunInvalid", "MaximumContentLengthExceeded", "MaximumTapeCartridgeCountExceeded", "MaximumVolumeCountExceeded", "NetworkConfigurationChanged", "NoDisksAvailable", "NotImplemented", "NotSupported", "OperationAborted", "OutdatedGateway", "ParametersNotImplemented", "RegionInvalid", "RequestTimeout", "ServiceUnavailable", "SnapshotDeleted", "SnapshotIdInvalid", "SnapshotInProgress", "SnapshotNotFound", "SnapshotScheduleNotFound", "StagingAreaFull", "StorageFailure", "TapeCartridgeNotFound", "TargetAlreadyExists", "TargetInvalid", "TargetNotFound", "UnauthorizedOperation", "VolumeAlreadyExists", "VolumeIdInvalid", "VolumeInUse", "VolumeNotFound", "VolumeNotReady" ], "documentation": "\n

Additional information about the error.

\n " }, "errorDetails": { "shape_name": "errorDetails", "type": "map", "keys": { "shape_name": "string", "type": "string", "documentation": null }, "members": { "shape_name": "string", "type": "string", "documentation": null }, "documentation": "\n

Human-readable text that provides detail about the error that occured.

\n " } }, "documentation": "\n

A StorageGatewayError that provides more detail about the cause of the error.

\n " } }, "documentation": "\n

An internal server error has occured during the request. See the error and message fields for more\n information.

\n " } ], "documentation": "\n

This operation updates a snapshot schedule configured for a gateway volume.

\n

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume.\n You can use this API to change the shapshot schedule configured for the volume.

\n

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the\n schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of\n snapshots.

\n \n \n Example Request\n The following example shows a request that updates a snapshot schedule.\n \nPOST / HTTP/1.1\nHost: storagegateway.us-east-1.amazonaws.com\nx-amz-Date: 20120425T120000Z\nAuthorization: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nContent-type: application/x-amz-json-1.1\nx-amz-target: StorageGateway_20120630.UpdateSnapshotSchedule\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\",\n \"StartAt\": 0,\n \"RecurrenceInHours\": 1,\n \"Description\": \"hourly snapshot\"\n}\n \n \nHTTP/1.1 200 OK\nx-amzn-RequestId: CSOC7TJPLR0OOKIRLGOHVAICUFVV4KQNSO5AEMVJF66Q9ASUAAJG\nDate: Wed, 25 Apr 2012 12:00:02 GMT\nContent-type: application/x-amz-json-1.1\nContent-length: 99\n{\n \"VolumeARN\": \"arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB\"\n}\n \n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://storagegateway.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "ThrottlingException", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/sts.json0000644000175000017500000024244112254746566017763 0ustar takakitakaki{ "api_version": "2011-06-15", "type": "query", "result_wrapped": true, "signature_version": "v4", "service_full_name": "AWS Security Token Service", "service_abbreviation": "AWS STS", "global_endpoint": "sts.amazonaws.com", "endpoint_prefix": "sts", "xmlnamespace": "https://sts.amazonaws.com/doc/2011-06-15/", "documentation": "\n\t\tAWS Security Token Service\n\n\t\t

The AWS Security Token Service (AWS STS) is a web service that enables you to request temporary,\n\t\t\tlimited-privilege credentials for AWS Identity and Access Management (AWS IAM) users or for users that you authenticate\n\t\t\t(federated users). This guide provides descriptions of the AWS STS API. For more detailed\n\t\t\tinformation about using this service, go to Using\n\t\t\t\tTemporary Security Credentials.

\n\n\t\t As an alternative to using the API, you can use one of the AWS SDKs, which consist of\n\t\t\tlibraries and sample code for various programming languages and platforms (Java, Ruby, .NET,\n\t\t\tiOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to\n\t\t\tAWS STS. For example, the SDKs take care of cryptographically signing requests, managing\n\t\t\terrors, and retrying requests automatically. For information about the AWS SDKs, including how\n\t\t\tto download and install them, see the Tools for Amazon\n\t\t\t\tWeb Services page. \n\n\t\t

For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For\n\t\t\tgeneral information about the Query API, go to Making Query Requests in Using IAM. For information about using\n\t\t\tsecurity tokens with other AWS products, go to Using Temporary\n\t\t\t\tSecurity Credentials to Access AWS in Using Temporary Security Credentials.

\n\n\t\t

If you're new to AWS and need additional technical information about a specific AWS product,\n\t\t\tyou can find the product's technical documentation at http://aws.amazon.com/documentation/.

\n\n\t\t

\n\t\t\tEndpoints\n\t\t

\n\t\t

For information about AWS STS endpoints, see Regions and Endpoints in the AWS General Reference.

\n\t", "operations": { "AssumeRole": { "name": "AssumeRole", "input": { "shape_name": "AssumeRoleRequest", "type": "structure", "members": { "RoleArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the role that the caller is assuming.

\n\t", "required": true }, "RoleSessionName": { "shape_name": "userNameType", "type": "string", "min_length": 2, "max_length": 32, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

An identifier for the assumed role session. The session name is included as part of the\n\t\t\t\tAssumedRoleUser.

\n\t", "required": true }, "Policy": { "shape_name": "sessionPolicyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 2048, "documentation": "\n\t\t

An AWS IAM policy in JSON format.

\n\t\t\n\t\t

The temporary security credentials that are returned by the operation have the permissions that are \n\t\t\tassociated with the access policy of the role being assumed, except for any permissions explicitly denied \n\t\t\tby the policy you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. \n\t\t\tThese policies and any applicable resource-based policies are evaluated when calls to AWS are made \n\t\t\tusing the temporary security credentials. \n\t\t

\n\t" }, "DurationSeconds": { "shape_name": "roleDurationSecondsType", "type": "integer", "min_length": 900, "max_length": 3600, "documentation": "\n\t\t

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n\t\t\tminutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

\n\t" }, "ExternalId": { "shape_name": "externalIdType", "type": "string", "min_length": 2, "max_length": 96, "pattern": "[\\w+=,.@:-]*", "documentation": "\n\t\t

A unique identifier that is used by third parties to assume a role in their customers'\n\t\t\taccounts. For each role that the third party can assume, they should instruct their customers\n\t\t\tto create a role with the external ID that the third party generated. Each time the third\n\t\t\tparty assumes the role, they must pass the customer's external ID. The external ID is useful\n\t\t\tin order to help third parties bind a role to the customer who created it. For more\n\t\t\tinformation about the external ID, see About the External ID in Using Temporary Security Credentials.\n\t\t

\n\t" } }, "documentation": null }, "output": { "shape_name": "AssumeRoleResponse", "type": "structure", "members": { "Credentials": { "shape_name": "Credentials", "type": "structure", "members": { "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID that identifies the temporary security credentials.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "documentation": "\n\t\t

The secret access key that can be used to sign requests.

\n\t", "required": true }, "SessionToken": { "shape_name": "tokenType", "type": "string", "documentation": "\n\t\t

The token that users must pass to the service API to use the temporary credentials.

\n\t", "required": true }, "Expiration": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date on which the current credentials expire.

\n\t", "required": true } }, "documentation": "\n\t\t

The temporary security credentials, which include an access key ID, a secret access key, and\n\t\t\ta security token.

\n\t" }, "AssumedRoleUser": { "shape_name": "AssumedRoleUser", "type": "structure", "members": { "AssumedRoleId": { "shape_name": "assumedRoleIdType", "type": "string", "min_length": 2, "max_length": 96, "pattern": "[\\w+=,.@:-]*", "documentation": "\n\t\t

A unique identifier that contains the role ID and the role session name of the role that is\n\t\t\tbeing assumed. The role ID is generated by AWS when the role is created.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The ARN of the temporary security credentials that are returned from the AssumeRole\n\t\t\taction. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

\n\t", "required": true } }, "documentation": "\n\t\t

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can\n\t\t\tuse to refer to the resulting temporary security credentials. For example, you can reference\n\t\t\tthese credentials as a principal in a resource-based policy by using the ARN or assumed role\n\t\t\tID. The ARN and ID include the RoleSessionName that you specified when you called\n\t\t\t\tAssumeRole.

\n\t" }, "PackedPolicySize": { "shape_name": "nonNegativeIntegerType", "type": "integer", "min_length": 0, "documentation": "\n\t\t

A percentage value that indicates the size of the policy in packed form. The service rejects\n\t\t\tany policy with a packed size greater than 100 percent, which means the policy exceeded the\n\t\t\tallowed space.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful call to the AssumeRole action, including\n\t\t\ttemporary AWS credentials that can be used to make AWS requests.

\n\t" }, "errors": [ { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "PackedPolicyTooLargeException", "type": "structure", "members": { "message": { "shape_name": "packedPolicyTooLargeMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was too large. The error message\n\t\t\tdescribes how big the policy document is, in packed form, as a percentage of what the API\n\t\t\tallows.

\n\t" } ], "documentation": "\n\t\t

Returns a set of temporary security credentials (consisting of an access key ID, a secret\n\t\t\taccess key, and a security token) that you can use to access AWS resources that you might not\n\t\t\tnormally have access to. Typically, you use AssumeRole for cross-account access\n\t\t\tor federation.

\n\t\t\n\t\t

For cross-account access, imagine that you own multiple accounts and need to access\n\t\t\tresources in each account. You could create long-term credentials in each account to access\n\t\t\tthose resources. However, managing all those credentials and remembering which one can access\n\t\t\twhich account can be time consuming. Instead, you can create one set of long-term credentials\n\t\t\tin one account and then use temporary security credentials to access all the other accounts by\n\t\t\tassuming roles in those accounts. For more information about roles, see Roles in\n\t\t\t\tUsing IAM.

\n\t\t\n\t\t

For federation, you can, for example, grant single sign-on access to the AWS Management\n\t\t\tConsole. If you already have an identity and authentication system in your corporate network,\n\t\t\tyou don't have to recreate user identities in AWS in order to grant those user identities\n\t\t\taccess to AWS. Instead, after a user has been authenticated, you call AssumeRole\n\t\t\t(and specify the role with the appropriate permissions) to get temporary security credentials\n\t\t\tfor that user. With those temporary security credentials, you construct a sign-in URL that\n\t\t\tusers can use to access the console. For more information, see Scenarios for\n\t\t\t\tGranting Temporary Access in AWS Security Token Service.

\n\t\t\n\t\t

The temporary security credentials are valid for the duration that you specified when\n\t\t\tcalling AssumeRole, which can be from 900 seconds (15 minutes) to 3600 seconds (1\n\t\t\thour). The default is 1 hour.

\n\t\t\n\t\t\n\t\t

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that \n\t\t\tare returned by the operation have the permissions that are associated with the access policy\n\t\t\tof the role that is being assumed, except for any permissions explicitly denied by the policy you pass.\n\t\t\tThis gives you a way to further restrict the permissions for the resulting temporary security credentials. These policies and any \n\t\t\tapplicable resource-based policies are evaluated when calls to AWS are made using the temporary security \n\t\t\tcredentials. \n\t\t

\n\t\t\n\t\t

To assume a role, your AWS account must be trusted by the role. The trust relationship is\n\t\t\tdefined in the role's trust policy when the IAM role is created. You must also have a policy\n\t\t\tthat allows you to call sts:AssumeRole.

\n\t\t

\n\t\t\tImportant: You cannot call AssumeRole by using AWS account credentials;\n\t\t\taccess will be denied. You must use IAM user credentials or temporary security credentials to\n\t\t\tcall AssumeRole.

\n\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\thttps://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=AssumeRole\n&RoleSessionName=Bob\n&RoleArn=arn:aws:iam::123456789012:role/demo\n&Policy=%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22%3A%22Stmt1%22%2C%22Effect%22%\n 3A%22Allow%22%2C%22Action%22%3A%22s3%3A*%22%2C%22Resource%22%3A%22*%22%7D\n %5D%7D\n&DurationSeconds=3600\n&ExternalId=123ABC\n&AUTHPARAMS\n\t\t\t\n\n\t\t\t\n\t\t\t\t\n \n \n \n AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW\n LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd\n QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU\n 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz\n +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-15T23:28:33.359Z\n AKIAIOSFODNN7EXAMPLE\n \n \n arn:aws:sts::123456789012:assumed-role/demo/Bob\n ARO123EXAMPLE123:Bob\n \n 6\n \n \n c6104cbe-af31-11e0-8154-cbc7ccf896c7\n \n\n\t\t\t\n\n\t\t\n\t" }, "AssumeRoleWithSAML": { "name": "AssumeRoleWithSAML", "input": { "shape_name": "AssumeRoleWithSAMLRequest", "type": "structure", "members": { "RoleArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the role that the caller is assuming.

\n\t", "required": true }, "PrincipalArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the SAML provider in AWS IAM that describes the IdP.

\n\t", "required": true }, "SAMLAssertion": { "shape_name": "SAMLAssertionType", "type": "string", "min_length": 4, "max_length": 50000, "documentation": "\n\t\t

The base-64 encoded SAML authentication response provided by the IdP.

\n\t\t

For more information, see \n\t\t\tConfiguring a Relying Party and Adding Claims\n\t\t\tin the Using IAM guide.\n\t\t

\n\t", "required": true }, "Policy": { "shape_name": "sessionPolicyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 2048, "documentation": "\n\t\t

An AWS IAM policy in JSON format.

\n\t\t\t\n\t\t

The temporary security credentials that are returned by this operation have the permissions that are associated \n\t\t\twith the access policy of the role being assumed, except for any permissions explicitly denied by the \n\t\t\tpolicy you pass. These policies and any applicable resource-based policies are evaluated when \n\t\t\tcalls to AWS are made using the temporary security credentials. \n\t\t

\n\t\t\n\t\tThe policy must be 2048 bytes or shorter, and its packed size must be less than 450\n\t\t\tbytes.\n\t" }, "DurationSeconds": { "shape_name": "durationSecondsType", "type": "integer", "min_length": 900, "max_length": 129600, "documentation": "\n\t\t

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n\t\t\tminutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration\n\t\t\tcan also be specified in the SAML authentication response's NotOnOrAfter value.\n\t\t\tThe actual expiration time is whichever value is shorter.

\n\t\t\n\t\tThe maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if\n\t\t\tvalues outside this range are specified.\n\t\t\n\t" } }, "documentation": null }, "output": { "shape_name": "AssumeRoleWithSAMLResponse", "type": "structure", "members": { "Credentials": { "shape_name": "Credentials", "type": "structure", "members": { "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID that identifies the temporary security credentials.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "documentation": "\n\t\t

The secret access key that can be used to sign requests.

\n\t", "required": true }, "SessionToken": { "shape_name": "tokenType", "type": "string", "documentation": "\n\t\t

The token that users must pass to the service API to use the temporary credentials.

\n\t", "required": true }, "Expiration": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date on which the current credentials expire.

\n\t", "required": true } }, "documentation": "\n\t\t

AWS credentials for API authentication.

\n\t" }, "AssumedRoleUser": { "shape_name": "AssumedRoleUser", "type": "structure", "members": { "AssumedRoleId": { "shape_name": "assumedRoleIdType", "type": "string", "min_length": 2, "max_length": 96, "pattern": "[\\w+=,.@:-]*", "documentation": "\n\t\t

A unique identifier that contains the role ID and the role session name of the role that is\n\t\t\tbeing assumed. The role ID is generated by AWS when the role is created.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The ARN of the temporary security credentials that are returned from the AssumeRole\n\t\t\taction. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

\n\t", "required": true } }, "documentation": "\n\t\t

The identifiers for the temporary security credentials that the operation returns.

\n\t" }, "PackedPolicySize": { "shape_name": "nonNegativeIntegerType", "type": "integer", "min_length": 0, "documentation": "\n\t\t

A percentage value that indicates the size of the policy in packed form. The service rejects\n\t\t\tany policy with a packed size greater than 100 percent, which means the policy exceeded the\n\t\t\tallowed space.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful call to the AssumeRoleWithSAML action, including\n\t\t\ttemporary AWS credentials that can be used to make AWS requests.

\n\t" }, "errors": [ { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "PackedPolicyTooLargeException", "type": "structure", "members": { "message": { "shape_name": "packedPolicyTooLargeMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was too large. The error message\n\t\t\tdescribes how big the policy document is, in packed form, as a percentage of what the API\n\t\t\tallows.

\n\t" }, { "shape_name": "IDPRejectedClaimException", "type": "structure", "members": { "message": { "shape_name": "idpRejectedClaimMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The identity provider (IdP) reported that authentication failed. This might be because the \n\t\t\t claim is invalid.

\n\t\t

If this error is returned for the AssumeRoleWithWebIdentity operation,\n\t\t\t it can also mean that the claim has expired or has been explicitly revoked.\n\t\t

\n\t" }, { "shape_name": "InvalidIdentityTokenException", "type": "structure", "members": { "message": { "shape_name": "invalidIdentityTokenMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The web identity token that was passed could not be validated by AWS. Get a new identity\n\t\t\ttoken from the identity provider and then retry the request.

\n\t" }, { "shape_name": "ExpiredTokenException", "type": "structure", "members": { "message": { "shape_name": "expiredIdentityTokenMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity\n\t\t\tprovider and then retry the request.

\n\t" } ], "documentation": "\n\t\t

Returns a set of temporary security credentials for users who have been authenticated via a\n\t\t\tSAML authentication response. This operation provides a mechanism for tying an enterprise\n\t\t\tidentity store or directory to role-based AWS access without user-specific credentials or\n\t\t\tconfiguration.

\n\n\t\t

The temporary security credentials returned by this operation consist of an access key ID, a\n\t\t\tsecret access key, and a security token. Applications can use these temporary security\n\t\t\tcredentials to sign calls to AWS services. The credentials are valid for the duration that you\n\t\t\tspecified when calling AssumeRoleWithSAML, which can be up to 3600 seconds (1\n\t\t\thour) or until the time specified in the SAML authentication response's\n\t\t\t\tNotOnOrAfter value, whichever is shorter.

\n\t\t\n\t\tThe maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if\n\t\t\tvalues outside this range are specified.\n\t\t\n\t\t\n\t\t

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that \n\t\t\tare returned by the operation have the permissions that are associated with the access policy of\n\t\t\tthe role being assumed, except for any permissions explicitly denied by the policy you pass.\n\t\t\tThis gives you a way to further restrict the permissions for the resulting temporary security credentials. These policies and any \n\t\t\tapplicable resource-based policies are evaluated when calls to AWS are made using the temporary security \n\t\t\tcredentials. \n\t\t

\n\t\t\n\t\t

Before your application can call AssumeRoleWithSAML, you must configure your\n\t\t\tSAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use\n\t\t\tAWS Identity and Access Management (AWS IAM) to create a SAML provider entity in your AWS account that represents your\n\t\t\tidentity provider, and create an AWS IAM role that specifies this SAML provider in its trust\n\t\t\tpolicy.

\n\n\t\t

Calling AssumeRoleWithSAML does not require the use of AWS security\n\t\t\tcredentials. The identity of the caller is validated by using keys in the metadata document\n\t\t\tthat is uploaded for the SAML provider entity for your identity provider.

\n\t\t\n\t\t

For more information, see the following resources:

\n\n\t\t\n\n\t\t\n\t\t\n\t\t\n\t\t\n\t" }, "AssumeRoleWithWebIdentity": { "name": "AssumeRoleWithWebIdentity", "input": { "shape_name": "AssumeRoleWithWebIdentityRequest", "type": "structure", "members": { "RoleArn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The Amazon Resource Name (ARN) of the role that the caller is assuming.

\n\t", "required": true }, "RoleSessionName": { "shape_name": "userNameType", "type": "string", "min_length": 2, "max_length": 32, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

An identifier for the assumed role session. Typically, you pass the name or identifier that\n\t\t\tis associated with the user who is using your application. That way, the temporary security\n\t\t\tcredentials that your application will use are associated with that user. This session name is\n\t\t\tincluded as part of the ARN and assumed role ID in the AssumedRoleUser response\n\t\t\telement.

\n\t", "required": true }, "WebIdentityToken": { "shape_name": "clientTokenType", "type": "string", "min_length": 4, "max_length": 2048, "documentation": "\n\t\t

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity\n\t\t\tprovider. Your application must get this token by authenticating the user who is using your\n\t\t\tapplication with a web identity provider before the application makes an\n\t\t\t\tAssumeRoleWithWebIdentity call.

\n\t", "required": true }, "ProviderId": { "shape_name": "urlType", "type": "string", "min_length": 4, "max_length": 2048, "documentation": "\n\t\t

The fully-qualified host component of the domain name of the identity provider. Specify this\n\t\t\tvalue only for OAuth access tokens. Do not specify this value for OpenID Connect ID tokens,\n\t\t\tsuch as accounts.google.com. Do not include URL schemes and port numbers.\n\t\t\tCurrently, www.amazon.com and graph.facebook.com are supported.

\n\t" }, "Policy": { "shape_name": "sessionPolicyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 2048, "documentation": "\n\t\t

An AWS IAM policy in JSON format.

\n\t\t\n\t\t

The temporary security credentials that are returned by the operation have the permissions that are \n\t\t\tassociated with the access policy of the role being assumed, except for any permissions explicitly denied \n\t\t\tby the policy you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. \n\t\t\tThese policies and any applicable resource-based policies are evaluated when calls to AWS are made \n\t\t\tusing the temporary security credentials. \n\t\t

\n\t" }, "DurationSeconds": { "shape_name": "durationSecondsType", "type": "integer", "min_length": 900, "max_length": 129600, "documentation": "\n\t\t

The duration, in seconds, of the role session. The value can range from 900 seconds (15\n\t\t\tminutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

\n\t" } }, "documentation": null }, "output": { "shape_name": "AssumeRoleWithWebIdentityResponse", "type": "structure", "members": { "Credentials": { "shape_name": "Credentials", "type": "structure", "members": { "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID that identifies the temporary security credentials.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "documentation": "\n\t\t

The secret access key that can be used to sign requests.

\n\t", "required": true }, "SessionToken": { "shape_name": "tokenType", "type": "string", "documentation": "\n\t\t

The token that users must pass to the service API to use the temporary credentials.

\n\t", "required": true }, "Expiration": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date on which the current credentials expire.

\n\t", "required": true } }, "documentation": "\n\t\t

The temporary security credentials, which include an access key ID, a secret access key, and\n\t\t\ta security token.

\n\t" }, "SubjectFromWebIdentityToken": { "shape_name": "webIdentitySubjectType", "type": "string", "min_length": 6, "max_length": 255, "documentation": "\n\t\t

The unique user identifier that is returned by the identity provider. This identifier is\n\t\t\tassociated with the WebIdentityToken that was submitted with the\n\t\t\t\tAssumeRoleWithWebIdentity call. The identifier is typically unique to the user\n\t\t\tand the application that acquired the WebIdentityToken (pairwise identifier). If\n\t\t\tan OpenID Connect ID token was submitted in the WebIdentityToken, this value is\n\t\t\treturned by the identity provider as the token's sub (Subject) claim.

\n\t" }, "AssumedRoleUser": { "shape_name": "AssumedRoleUser", "type": "structure", "members": { "AssumedRoleId": { "shape_name": "assumedRoleIdType", "type": "string", "min_length": 2, "max_length": 96, "pattern": "[\\w+=,.@:-]*", "documentation": "\n\t\t

A unique identifier that contains the role ID and the role session name of the role that is\n\t\t\tbeing assumed. The role ID is generated by AWS when the role is created.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The ARN of the temporary security credentials that are returned from the AssumeRole\n\t\t\taction. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

\n\t", "required": true } }, "documentation": "\n\t\t

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can\n\t\t\tuse to refer to the resulting temporary security credentials. For example, you can reference\n\t\t\tthese credentials as a principal in a resource-based policy by using the ARN or assumed role\n\t\t\tID. The ARN and ID include the RoleSessionName that you specified when you called\n\t\t\t\tAssumeRole.

\n\t" }, "PackedPolicySize": { "shape_name": "nonNegativeIntegerType", "type": "integer", "min_length": 0, "documentation": "\n\t\t

A percentage value that indicates the size of the policy in packed form. The service rejects\n\t\t\tany policy with a packed size greater than 100 percent, which means the policy exceeded the\n\t\t\tallowed space.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful call to the AssumeRoleWithWebIdentity action,\n\t\t\tincluding temporary AWS credentials that can be used to make AWS requests.

\n\t" }, "errors": [ { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "PackedPolicyTooLargeException", "type": "structure", "members": { "message": { "shape_name": "packedPolicyTooLargeMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was too large. The error message\n\t\t\tdescribes how big the policy document is, in packed form, as a percentage of what the API\n\t\t\tallows.

\n\t" }, { "shape_name": "IDPRejectedClaimException", "type": "structure", "members": { "message": { "shape_name": "idpRejectedClaimMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The identity provider (IdP) reported that authentication failed. This might be because the \n\t\t\t claim is invalid.

\n\t\t

If this error is returned for the AssumeRoleWithWebIdentity operation,\n\t\t\t it can also mean that the claim has expired or has been explicitly revoked.\n\t\t

\n\t" }, { "shape_name": "IDPCommunicationErrorException", "type": "structure", "members": { "message": { "shape_name": "idpCommunicationErrorMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked\n\t\t\tto verify the incoming identity token could not be reached. This is often a transient error\n\t\t\tcaused by network conditions. Retry the request a limited number of times so that you don't\n\t\t\texceed the request rate. If the error persists, the non-AWS identity provider might be down or\n\t\t\tnot responding.

\n\t" }, { "shape_name": "InvalidIdentityTokenException", "type": "structure", "members": { "message": { "shape_name": "invalidIdentityTokenMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The web identity token that was passed could not be validated by AWS. Get a new identity\n\t\t\ttoken from the identity provider and then retry the request.

\n\t" }, { "shape_name": "ExpiredTokenException", "type": "structure", "members": { "message": { "shape_name": "expiredIdentityTokenMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity\n\t\t\tprovider and then retry the request.

\n\t" } ], "documentation": "\n\t\t

Returns a set of temporary security credentials for users who have been authenticated in a\n\t\t\tmobile or web application with a web identity provider, such as Login with Amazon, Facebook,\n\t\t\tor Google. AssumeRoleWithWebIdentity is an API call that does not require the use\n\t\t\tof AWS security credentials. Therefore, you can distribute an application (for example, on\n\t\t\tmobile devices) that requests temporary security credentials without including long-term AWS\n\t\t\tcredentials in the application or by deploying server-based proxy services that use long-term\n\t\t\tAWS credentials.

\n\n\t\t

The temporary security credentials consist of an access key ID, a secret access key, and a\n\t\t\tsecurity token. Applications can use these temporary security credentials to sign calls to AWS\n\t\t\tservice APIs. The credentials are valid for the duration that you specified when calling\n\t\t\t\tAssumeRoleWithWebIdentity, which can be from 900 seconds (15 minutes) to 3600\n\t\t\tseconds (1 hour). By default, the temporary security credentials are valid for 1 hour.

\n\n\t\t

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that are \n\t\t\treturned by the operation have the permissions that are associated with the access policy of the role being assumed, \n\t\t\texcept for any permissions explicitly denied by the policy you pass. This gives you a way\n\t\t\tto further restrict the permissions for the resulting temporary security credentials. These policies and any applicable \n\t\t\tresource-based policies are evaluated when calls to AWS are made using the temporary security credentials. \n\t\t

\n\t\t\n\t\t

Before your application can call AssumeRoleWithWebIdentity, you must have an\n\t\t\tidentity token from a supported identity provider and create a role that the application can\n\t\t\tassume. The role that your application assumes must trust the identity provider that is\n\t\t\tassociated with the identity token. In other words, the identity provider must be specified in\n\t\t\tthe role's trust policy.

\n\n\t\t

For more information about how to use web identity federation and the\n\t\t\t\tAssumeRoleWithWebIdentity, see the following resources:

\n\n\t\t\n\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\n\t\t\n\n\t\t\t\n\t\t\t\thttps://sts.amazonaws.com/\n?Action=AssumeRoleWithWebIdentity\n&DurationSeconds=3600\n&ProviderId=www.amazon.com\n&RoleSessionName=app1\n&Version=2011-06-15\n&RoleArn=arn%3Aaws%3Aiam%3A%3A000240903217%3Arole%2FFederatedWebIdentityRole\n&WebIdentityToken=Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXX\nXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFB\nmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNI\nL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAG\npsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ\n\t\t\t\n\n\t\t\t\n\t\t\t\t\n \n \n amzn1.account.AF6RHO7KZU5XRVQJGXK6HB56KR2A\n \n \n \n arn:aws:sts::000240903217:assumed-role/FederatedWebIdentityRole/app1\n \n \n AROACLKWSDQRAOFQC3IDI:app1\n \n \n \n \n AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IPfnyowF\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n \n 2013-05-14T23:00:23Z\n \n \n AKIAIOSFODNN7EXAMPLE\n \n \n \n \n ad4156e9-bce1-11e2-82e6-6b6ef249e618\n \n\n\t\t\t\n\t\t\n\t" }, "DecodeAuthorizationMessage": { "name": "DecodeAuthorizationMessage", "input": { "shape_name": "DecodeAuthorizationMessageRequest", "type": "structure", "members": { "EncodedMessage": { "shape_name": "encodedMessageType", "type": "string", "min_length": 1, "max_length": 10240, "documentation": "\n\t\t

The encoded message that was returned with the response.

\n\t", "required": true } }, "documentation": null }, "output": { "shape_name": "DecodeAuthorizationMessageResponse", "type": "structure", "members": { "DecodedMessage": { "shape_name": "decodedMessageType", "type": "string", "documentation": "\n\t\t

An XML document that contains the decoded message. For more information, see\n\t\t\t\tDecodeAuthorizationMessage.

\n\t" } }, "documentation": "\n\t\t

A document that contains additional information about the authorization status of a request\n\t\t\tfrom an encoded message that is returned in response to an AWS request.

\n\t" }, "errors": [ { "shape_name": "InvalidAuthorizationMessageException", "type": "structure", "members": { "message": { "shape_name": "invalidAuthorizationMessage", "type": "string", "documentation": "\n\t\t

The error message associated with the error.

\n\t" } }, "documentation": "\n\t\t

The error returned if the message passed to DecodeAuthorizationMessage was\n\t\t\tinvalid. This can happen if the token contains invalid characters, such as linebreaks.

\n\t" } ], "documentation": "\n\t\t

Decodes additional information about the authorization status of a request from an encoded\n\t\t\tmessage returned in response to an AWS request.

\n\n\t\t

For example, if a user is not authorized to perform an action that he or she has requested,\n\t\t\tthe request returns a Client.UnauthorizedOperation response (an HTTP 403\n\t\t\tresponse). Some AWS actions additionally return an encoded message that can provide details\n\t\t\tabout this authorization failure.

\n\n\t\t Only certain AWS actions return an encoded authorization message. The documentation for\n\t\t\tan individual action indicates whether that action returns an encoded message in addition to\n\t\t\treturning an HTTP code. \n\n\t\t

The message is encoded because the details of the authorization status can constitute\n\t\t\tprivileged information that the user who requested the action should not see. To decode an\n\t\t\tauthorization status message, a user must be granted permissions via an AWS IAM policy to\n\t\t\trequest the DecodeAuthorizationMessage\n\t\t\t\t(sts:DecodeAuthorizationMessage) action.

\n\n\t\t

The decoded message includes the following type of information:

\n\n\t\t\n\n\t\t\n\t\t\t\nPOST https://sts.amazonaws.com / HTTP/1.1\nContent-Type: application/x-www-form-urlencoded; charset=utf-8\nHost: sts.amazonaws.com\nContent-Length: 1148\nExpect: 100-continue\nConnection: Keep-Alive\nAction=DecodeAuthorizationMessage\n&EncodedMessage=\n&Version=2011-06-15\n&AUTHPARAMS\n\n\t\t\t\n \n 6624a9ca-cd25-4f50-b2a5-7ba65bf07453\n \n {\n \"allowed\": \"false\",\n \"explicitDeny\": \"false\",\n \"matchedStatements\": \"\",\n \"failures\": \"\",\n \"context\": {\n \"principal\": {\n \"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\n \"name\": \"Bob\",\n \"arn\": \"arn:aws:iam::123456789012:user/Bob\"\n },\n \"action\": \"ec2:StopInstances\",\n \"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\n \"conditions\": [\n {\n \"item\": {\n \"key\": \"ec2:Tenancy\",\n \"values\": [\"default\"]\n },\n {\n \"item\": {\n \"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\n \"values\": [\"Default-Environment\"]\n }\n },\n (Additional items ...)\n ]\n }\n }\n \n\n\t\t\n\t" }, "GetFederationToken": { "name": "GetFederationToken", "input": { "shape_name": "GetFederationTokenRequest", "type": "structure", "members": { "Name": { "shape_name": "userNameType", "type": "string", "min_length": 2, "max_length": 32, "pattern": "[\\w+=,.@-]*", "documentation": "\n\t\t

The name of the federated user. The name is used as an identifier for the temporary security\n\t\t\tcredentials (such as Bob). For example, you can reference the federated user name\n\t\t\tin a resource-based policy, such as in an Amazon S3 bucket policy.

\n\t", "required": true }, "Policy": { "shape_name": "sessionPolicyDocumentType", "type": "string", "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "min_length": 1, "max_length": 2048, "documentation": "\n\t\t

An AWS IAM policy in JSON format.

\n\t\t\n\t\t

By default, federated users have no permissions; they do not inherit any from the IAM user. When you\n\t\t\tspecify a policy, the federated user's permissions are based on the specified policy and the IAM user's policy. \n\t\t\tIf you don't specify a policy, federated users can only access AWS resources that explicitly allow those federated \n\t\t\tusers in a resource policy, such as in an Amazon S3 bucket policy.\n\t\t

\n\t" }, "DurationSeconds": { "shape_name": "durationSecondsType", "type": "integer", "min_length": 900, "max_length": 129600, "documentation": "\n\t\t

The duration, in seconds, that the session should last. Acceptable durations for federation\n\t\t\tsessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds\n\t\t\t(12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600\n\t\t\tseconds (one hour). If the duration is longer than one hour, the session for AWS account\n\t\t\towners defaults to one hour.

\n\t" } }, "documentation": null }, "output": { "shape_name": "GetFederationTokenResponse", "type": "structure", "members": { "Credentials": { "shape_name": "Credentials", "type": "structure", "members": { "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID that identifies the temporary security credentials.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "documentation": "\n\t\t

The secret access key that can be used to sign requests.

\n\t", "required": true }, "SessionToken": { "shape_name": "tokenType", "type": "string", "documentation": "\n\t\t

The token that users must pass to the service API to use the temporary credentials.

\n\t", "required": true }, "Expiration": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date on which the current credentials expire.

\n\t", "required": true } }, "documentation": "\n\t\t

Credentials for the service API authentication.

\n\t" }, "FederatedUser": { "shape_name": "FederatedUser", "type": "structure", "members": { "FederatedUserId": { "shape_name": "federatedIdType", "type": "string", "min_length": 2, "max_length": 96, "pattern": "[\\w+=,.@\\:-]*", "documentation": "\n\t\t

The string that identifies the federated user associated with the credentials, similar to the\n\t\t\tunique ID of an IAM user.

\n\t", "required": true }, "Arn": { "shape_name": "arnType", "type": "string", "min_length": 20, "max_length": 2048, "documentation": "\n\t\t

The ARN that specifies the federated user that is associated with the credentials. For more\n\t\t\tinformation about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using IAM.

\n\t", "required": true } }, "documentation": "\n\t\t

Identifiers for the federated user associated with the credentials (such as\n\t\t\t\tarn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).\n\t\t\tYou can use the federated user's ARN in your resource policies like in an Amazon S3 bucket\n\t\t\tpolicy.

\n\t" }, "PackedPolicySize": { "shape_name": "nonNegativeIntegerType", "type": "integer", "min_length": 0, "documentation": "\n\t\t

A percentage value indicating the size of the policy in packed form. The service rejects\n\t\t\tpolicies for which the packed size is greater than 100 percent of the allowed value.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful call to the GetFederationToken action, including\n\t\t\ttemporary AWS credentials that can be used to make AWS requests.

\n\t" }, "errors": [ { "shape_name": "MalformedPolicyDocumentException", "type": "structure", "members": { "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.

\n\t" }, { "shape_name": "PackedPolicyTooLargeException", "type": "structure", "members": { "message": { "shape_name": "packedPolicyTooLargeMessage", "type": "string", "documentation": null } }, "documentation": "\n\t\t

The request was rejected because the policy document was too large. The error message\n\t\t\tdescribes how big the policy document is, in packed form, as a percentage of what the API\n\t\t\tallows.

\n\t" } ], "documentation": "\n\t\t

Returns a set of temporary security credentials (consisting of an access key ID, a secret\n\t\t\taccess key, and a security token) for a federated user. A typical use is in a proxy\n\t\t\tapplication that is getting temporary security credentials on behalf of distributed\n\t\t\tapplications inside a corporate network. Because you must call the\n\t\t\t\tGetFederationToken action using the long-term security credentials of an IAM\n\t\t\tuser, this call is appropriate in contexts where those credentials can be safely stored,\n\t\t\tusually in a server-based application.

\n\n\t\t

\n\t\t\tNote: Do not use this call in mobile applications or client-based web applications that\n\t\t\tdirectly get temporary security credentials. For those types of applications, use\n\t\t\t\tAssumeRoleWithWebIdentity.

\n\n\t\t

The GetFederationToken action must be called by using the long-term AWS\n\t\t\tsecurity credentials of the AWS account or an IAM user. Credentials that are created by IAM\n\t\t\tusers are valid for the specified duration, between 900 seconds (15 minutes) and 129600\n\t\t\tseconds (36 hours); credentials that are created by using account credentials have a maximum\n\t\t\tduration of 3600 seconds (1 hour).

\n\t\t\n\t\t

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that \n\t\t\tare returned by the operation have the permissions that are associated with the entity that is making \n\t\t\tthe GetFederationToken call, except for any permissions explicitly denied by the policy you pass.\n\t\t\tThis gives you a way to further restrict the permissions for the resulting temporary security credentials. These policies and any \n\t\t\tapplicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials. \n\t\t

\n\t\t\n\t\t

For more information about how permissions work, see Controlling Permissions in Temporary Credentials in Using Temporary Security\n\t\t\t\tCredentials. For information about using GetFederationToken to create\n\t\t\ttemporary security credentials, see Creating Temporary Credentials to Enable Access for Federated Users in\n\t\t\t\tUsing Temporary Security Credentials.

\n\n\t\t\n\t\t\t\n\t\t\t\thttps://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=GetFederationToken\n&Name=Bob\n&Policy=%7B%22Version%22%3A%222012-10-17%22%2C%22Statement%22%3A%5B%7B%22Sid%22%3A%22Stmt1%22%2C%22Effect%22%\n 3A%22Allow%22%2C%22Action%22%3A%22s3%3A*%22%2C%22Resource%22%3A%22*%22%7D\n %5D%7D\n&DurationSeconds=3600\n&AUTHPARAMS\n\t\t\t\n\n\t\t\t\n\t\t\t\t\n \n \n \n AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQW\n LWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGd\n QrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU\n 9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz\n +scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-15T23:28:33.359Z\n AKIAIOSFODNN7EXAMPLE\n \n \n arn:aws:sts::123456789012:federated-user/Bob\n 123456789012:Bob\n \n 6\n \n \n c6104cbe-af31-11e0-8154-cbc7ccf896c7\n \n\n\t\t\t\n\n\t\t\n\t" }, "GetSessionToken": { "name": "GetSessionToken", "input": { "shape_name": "GetSessionTokenRequest", "type": "structure", "members": { "DurationSeconds": { "shape_name": "durationSecondsType", "type": "integer", "min_length": 900, "max_length": 129600, "documentation": "\n\t\t

The duration, in seconds, that the credentials should remain valid. Acceptable durations for\n\t\t\tIAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200\n\t\t\tseconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum\n\t\t\tof 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS\n\t\t\taccount owners defaults to one hour.

\n\t" }, "SerialNumber": { "shape_name": "serialNumberType", "type": "string", "min_length": 9, "max_length": 256, "pattern": "[\\w+=/:,.@-]*", "documentation": "\n\t\t

The identification number of the MFA device that is associated with the IAM user who is\n\t\t\tmaking the GetSessionToken call. Specify this value if the IAM user has a policy\n\t\t\tthat requires MFA authentication. The value is either the serial number for a hardware device\n\t\t\t(such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device\n\t\t\t(such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM\n\t\t\tuser by going to the AWS Management Console and viewing the user's security credentials.

\n\t" }, "TokenCode": { "shape_name": "tokenCodeType", "type": "string", "min_length": 6, "max_length": 6, "pattern": "[\\d]*", "documentation": "\n\t\t

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user\n\t\t\tto submit an MFA code, specify this value. If MFA authentication is required, and the user\n\t\t\tdoes not provide a code when requesting a set of temporary security credentials, the user will\n\t\t\treceive an \"access denied\" response when requesting resources that require MFA\n\t\t\tauthentication.

\n\t" } }, "documentation": null }, "output": { "shape_name": "GetSessionTokenResponse", "type": "structure", "members": { "Credentials": { "shape_name": "Credentials", "type": "structure", "members": { "AccessKeyId": { "shape_name": "accessKeyIdType", "type": "string", "min_length": 16, "max_length": 32, "pattern": "[\\w]*", "documentation": "\n\t\t

The access key ID that identifies the temporary security credentials.

\n\t", "required": true }, "SecretAccessKey": { "shape_name": "accessKeySecretType", "type": "string", "documentation": "\n\t\t

The secret access key that can be used to sign requests.

\n\t", "required": true }, "SessionToken": { "shape_name": "tokenType", "type": "string", "documentation": "\n\t\t

The token that users must pass to the service API to use the temporary credentials.

\n\t", "required": true }, "Expiration": { "shape_name": "dateType", "type": "timestamp", "documentation": "\n\t\t

The date on which the current credentials expire.

\n\t", "required": true } }, "documentation": "\n\t\t

The session credentials for API authentication.

\n\t" } }, "documentation": "\n\t\t

Contains the result of a successful call to the GetSessionToken action, including\n\t\t\ttemporary AWS credentials that can be used to make AWS requests.

\n\t" }, "errors": [], "documentation": "\n\t\t

Returns a set of temporary credentials for an AWS account or IAM user. The credentials\n\t\t\tconsist of an access key ID, a secret access key, and a security token. Typically, you use\n\t\t\t\tGetSessionToken if you want use MFA to protect programmatic calls to specific\n\t\t\tAWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call\n\t\t\t\tGetSessionToken and submit an MFA code that is associated with their MFA\n\t\t\tdevice. Using the temporary security credentials that are returned from the call, IAM users\n\t\t\tcan then make programmatic calls to APIs that require MFA authentication.

\n\n\t\t

The GetSessionToken action must be called by using the long-term AWS security\n\t\t\tcredentials of the AWS account or an IAM user. Credentials that are created by IAM users are\n\t\t\tvalid for the duration that you specify, between 900 seconds (15 minutes) and 129600 seconds\n\t\t\t(36 hours); credentials that are created by using account credentials have a maximum duration\n\t\t\tof 3600 seconds (1 hour).

\n\n\t\t

Optionally, you can pass an AWS IAM access policy to this operation. The temporary security credentials that \n\t\t\tare returned by the operation have the permissions that are associated with the entity that is making \n\t\t\tthe GetSessionToken call, except for any permissions explicitly denied by the policy you pass.\n\t\t\tThis gives you a way to further restrict the permissions for the resulting temporary security credentials. These policies and any \n\t\t\tapplicable resource-based policies are evaluated when calls to AWS are made using the temporary security credentials. \n\t\t

\n\t\t\n\t\t

For more information about using GetSessionToken to create temporary\n\t\t\tcredentials, go to Creating Temporary Credentials to Enable Access for IAM Users in\n\t\t\t\tUsing IAM. \n\t\t

\n\n\t\t\n\t\t\t\n\t\t\t\thttps://sts.amazonaws.com/\n?Version=2011-06-15\n&Action=GetSessionToken\n&DurationSeconds=3600\n&SerialNumber=YourMFADeviceSerialNumber\n&TokenCode=123456\n&AUTHPARAMS\n\t\t\t\n\n\t\t\t\n\t\t\t\t\n \n \n \n AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L\n To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z\n rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp\n Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE\n \n \n wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY\n \n 2011-07-11T19:55:29.611Z\n AKIAIOSFODNN7EXAMPLE\n \n \n \n 58c5dbae-abef-11e0-8cfe-09039844ac7d\n \n\n\t\t\t\n\t\t\n\t" } }, "metadata": { "regions": { "us-east-1": "https://sts.amazonaws.com/", "us-gov-west-1": null, "cn-north-1": "https://sts.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/data/aws/support.json0000644000175000017500000027566212254746564020677 0ustar takakitakaki{ "api_version": "2013-04-15", "type": "json", "json_version": "1.1", "target_prefix": "AWSSupport_20130415", "signature_version": "v4", "service_full_name": "AWS Support", "endpoint_prefix": "support", "xmlnamespace": "http://support.amazonaws.com/doc/2013-04-15/", "documentation": "\n AWS Support\n \n \n

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

\n \n

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks you can run on your resources, specify checks to run and refresh, and check the status of checks you have submitted.

\n \n

The following list describes the AWS Support case management actions:

\n \n \n

The following list describes the actions available from the AWS Support service for Trusted Advisor:

\n \n \n \n \n

For authentication of requests, the AWS Support uses Signature Version 4 Signing Process.

\n \n

See the AWS Support Developer Guide for information about how to use this service to manage create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

\n \n \n ", "operations": { "AddCommunicationToCase": { "name": "AddCommunicationToCase", "input": { "shape_name": "AddCommunicationToCaseRequest", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " }, "communicationBody": { "shape_name": "CommunicationBody", "type": "string", "min_length": 1, "max_length": 8000, "documentation": "\n

Represents the body of an email communication added to the support case.

\n ", "required": true }, "ccEmailAddresses": { "shape_name": "CcEmailAddressList", "type": "list", "members": { "shape_name": "CcEmailAddress", "type": "string", "documentation": null }, "min_length": 0, "max_length": 10, "documentation": "\n

Represents any email addresses contained in the CC line of an email added to the support case.

\n " } }, "documentation": "\n

To be written.

\n " }, "output": { "shape_name": "AddCommunicationToCaseResponse", "type": "structure", "members": { "result": { "shape_name": "Result", "type": "boolean", "documentation": "\n

Returns true if the AddCommunicationToCase succeeds. Returns an error otherwise.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " }, { "shape_name": "CaseIdNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Error returned when the request does not return a case for the CaseId submitted.

\n " } }, "documentation": "\n

Returned when the CaseId requested could not be located.

\n " } ], "documentation": "\n

This action adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to which you want to add communication. You can list a set of email addresses to copy on the communication using the CcEmailAddresses value. The CommunicationBody value contains the text of the communication.

\n

This action's response indicates the success or failure of the request.

\n

This action implements a subset of the behavior on the AWS Support Your Support Cases web form.

\n " }, "CreateCase": { "name": "CreateCase", "input": { "shape_name": "CreateCaseRequest", "type": "structure", "members": { "subject": { "shape_name": "Subject", "type": "string", "documentation": "\n

Title of the AWS Support case.

\n ", "required": true }, "serviceCode": { "shape_name": "ServiceCode", "type": "string", "pattern": "[0-9a-z\\-_]+", "documentation": "\n

Code for the AWS service returned by the call to DescribeServices.

\n " }, "severityCode": { "shape_name": "SeverityCode", "type": "string", "documentation": "\n

Code for the severity level returned by the call to DescribeSeverityLevels.

\n The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.\n \n " }, "categoryCode": { "shape_name": "CategoryCode", "type": "string", "documentation": "\n

Specifies the category of problem for the AWS Support case.

\n " }, "communicationBody": { "shape_name": "CommunicationBody", "type": "string", "min_length": 1, "max_length": 8000, "documentation": "\n

Parameter that represents the communication body text when you create an AWS Support case by calling CreateCase.

\n ", "required": true }, "ccEmailAddresses": { "shape_name": "CcEmailAddressList", "type": "list", "members": { "shape_name": "CcEmailAddress", "type": "string", "documentation": null }, "min_length": 0, "max_length": 10, "documentation": "\n

List of email addresses that AWS Support copies on case correspondence.

\n " }, "language": { "shape_name": "Language", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " }, "issueType": { "shape_name": "IssueType", "type": "string", "documentation": "\n

Field passed as a parameter in a CreateCase call.

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "CreateCaseResponse", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " } }, "documentation": "\n

Contains the AWSSupport caseId returned by a successful completion of the CreateCase action.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " }, { "shape_name": "CaseCreationLimitExceeded", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Error message that indicates that you have exceeded the number of cases you can have open.

\n " } }, "documentation": "\n

Returned when you have exceeded the case creation limit for an account.

\n " } ], "documentation": "\n

Creates a new case in the AWS Support Center. This action is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:

\n
    \n
  1. \nServiceCode. Represents a code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
    2. \n
  2. \nCategoryCode. Represents a category for the service defined for the ServiceCode value. You also obtain the cateogory code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
    3. \n
  3. \nSeverityCode. Represents a value that specifies the urgency of the case, and the time interval in which your service level agreement specifies a response from AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
    4. \n
  4. \nSubject. Represents the Subject field on the AWS Support Center Open a new case page.
    5. \n
  5. \nCommunicationBody. Represents the Description field on the AWS Support Center Open a new case page.
    6. \n
  6. \nLanguage. Specifies the human language in which AWS Support handles the case. The API currently supports English and Japanese.
    7. \n
  7. \nCcEmailAddresses. Represents the AWS Support Center CC field on the Open a new case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.
    8. \n
  8. \nIssueType. Indicates the type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, this parameter defaults to \"technical.\"
    9. \n
\n \n The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case. \n \n

A successful CreateCase request returns an AWS Support case number. Case numbers are used by DescribeCases request to retrieve existing AWS Support support cases.

\n \n \n " }, "DescribeCases": { "name": "DescribeCases", "input": { "shape_name": "DescribeCasesRequest", "type": "structure", "members": { "caseIdList": { "shape_name": "CaseIdList", "type": "list", "members": { "shape_name": "CaseId", "type": "string", "documentation": null }, "min_length": 0, "max_length": 100, "documentation": "\n

A list of Strings comprising ID numbers for support cases you want returned. The maximum number of cases is 100.

\n " }, "displayId": { "shape_name": "DisplayId", "type": "string", "documentation": "\n

String that corresponds to the ID value displayed for a case in the AWS Support Center user interface.

\n " }, "afterTime": { "shape_name": "AfterTime", "type": "string", "documentation": "\n

Start date for a filtered date search on support case communications.

\n " }, "beforeTime": { "shape_name": "BeforeTime", "type": "string", "documentation": "\n

End date for a filtered date search on support case communications.

\n " }, "includeResolvedCases": { "shape_name": "IncludeResolvedCases", "type": "boolean", "documentation": "\n

Boolean that indicates whether or not resolved support cases should be listed in the DescribeCases search.

\n " }, "nextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

Defines a resumption point for pagination.

\n " }, "maxResults": { "shape_name": "MaxResults", "type": "integer", "min_length": 10, "max_length": 100, "documentation": "\n

Integer that sets the maximum number of results to return before paginating.

\n " }, "language": { "shape_name": "Language", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "DescribeCasesResponse", "type": "structure", "members": { "cases": { "shape_name": "CaseList", "type": "list", "members": { "shape_name": "CaseDetails", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " }, "displayId": { "shape_name": "DisplayId", "type": "string", "documentation": "\n

Represents the Id value displayed on pages for the case in AWS Support Center. This is a numeric string.

\n " }, "subject": { "shape_name": "Subject", "type": "string", "documentation": "\n

Represents the subject line for a support case in the AWS Support Center user interface.

\n " }, "status": { "shape_name": "Status", "type": "string", "documentation": "\n

Represents the status of a case submitted to AWS Support.

\n " }, "serviceCode": { "shape_name": "ServiceCode", "type": "string", "documentation": "\n

Code for the AWS service returned by the call to DescribeServices.

\n " }, "categoryCode": { "shape_name": "CategoryCode", "type": "string", "documentation": "\n

Specifies the category of problem for the AWS Support case.

\n " }, "severityCode": { "shape_name": "SeverityCode", "type": "string", "documentation": "\n

Code for the severity level returned by the call to DescribeSeverityLevels.

\n " }, "submittedBy": { "shape_name": "SubmittedBy", "type": "string", "documentation": "\n

Represents the email address of the account that submitted the case to support.

\n " }, "timeCreated": { "shape_name": "TimeCreated", "type": "string", "documentation": "\n

Time that the case was case created in AWS Support Center.

\n " }, "recentCommunications": { "shape_name": "RecentCaseCommunications", "type": "structure", "members": { "communications": { "shape_name": "CommunicationList", "type": "list", "members": { "shape_name": "Communication", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " }, "body": { "shape_name": "CommunicationBody", "type": "string", "documentation": "\n

Contains the text of the the commmunication between the customer and AWS Support.

\n " }, "submittedBy": { "shape_name": "SubmittedBy", "type": "string", "documentation": "\n

Email address of the account that submitted the AWS Support case.

\n " }, "timeCreated": { "shape_name": "TimeCreated", "type": "string", "documentation": "\n

Time the support case was created.

\n " } }, "documentation": "\n

Object that exposes the fields used by a communication for an AWS Support case.

\n " }, "documentation": "\n

List of Commmunication objects.

\n " }, "nextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

Defines a resumption point for pagination.

\n " } }, "documentation": "\n

Returns up to the five most recent communications between you and AWS Support Center. Includes a nextToken to retrieve the next set of communications.

\n " }, "ccEmailAddresses": { "shape_name": "CcEmailAddressList", "type": "list", "members": { "shape_name": "CcEmailAddress", "type": "string", "documentation": null }, "documentation": "\n

List of email addresses that are copied in any communication about the case.

\n " }, "language": { "shape_name": "Language", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " } }, "documentation": "\n

JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. This structure contains the following fields:

\n
    \n
  1. \nCaseID. String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47
    2. \n
  2. \nCategoryCode. Specifies the category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices\n
    3. \n
  3. \nDisplayId. String that identifies the case on pages in the AWS Support Center
    4. \n
  4. \nLanguage. Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.
    5. \n
  5. \nRecentCommunications. One ore more Communication data types. Subfields of these structures are Body, CaseId, SubmittedBy, and TimeCreated.
    6. \n
  6. \nNextToken. Defines a resumption point for pagination.
    7. \n
  7. \nServiceCode. Identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices\n
    8. \n
  8. \nSeverityCode. Specifies the severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels\n
    9. \n
  9. \nStatus. Represents the status of your case in the AWS Support Center
    10. \n
  10. \nSubject. Represents the subject line of the case.
    11. \n
  11. \nSubmittedBy.Email address of the account that submitted the case.
    12. \n
  12. \nTimeCreated.Time the case was created, using ISO 8601 format.
    13. \n
\n \n " }, "documentation": "\n Array of CaseDetails objects. \n " }, "nextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

Defines a resumption point for pagination.

\n " } }, "documentation": "\n

Returns an array of CaseDetails objects and a NextToken that defines a point for pagination in the result set.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " }, { "shape_name": "CaseIdNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Error returned when the request does not return a case for the CaseId submitted.

\n " } }, "documentation": "\n

Returned when the CaseId requested could not be located.

\n " } ], "documentation": "\n

This action returns a list of cases that you specify by passing one or more CaseIds. In addition, you can filter the cases by date by setting values for the AfterTime and BeforeTime request parameters.

\n \n The response returns the following in JSON format: \n
    \n
  1. One or more CaseDetails data types.
    2. \n
  2. One or more NextToken objects, strings that specifies where to paginate the returned records represented by CaseDetails.
    3. \n
\n " }, "DescribeCommunications": { "name": "DescribeCommunications", "input": { "shape_name": "DescribeCommunicationsRequest", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n ", "required": true }, "beforeTime": { "shape_name": "BeforeTime", "type": "string", "documentation": "\n

End date for a filtered date search on support case communications.

\n " }, "afterTime": { "shape_name": "AfterTime", "type": "string", "documentation": "\n

Start date for a filtered date search on support case communications.

\n " }, "nextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

Defines a resumption point for pagination.

\n " }, "maxResults": { "shape_name": "MaxResults", "type": "integer", "min_length": 10, "max_length": 100, "documentation": "\n

Integer that sets the maximum number of results to return before paginating.

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "DescribeCommunicationsResponse", "type": "structure", "members": { "communications": { "shape_name": "CommunicationList", "type": "list", "members": { "shape_name": "Communication", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " }, "body": { "shape_name": "CommunicationBody", "type": "string", "documentation": "\n

Contains the text of the the commmunication between the customer and AWS Support.

\n " }, "submittedBy": { "shape_name": "SubmittedBy", "type": "string", "documentation": "\n

Email address of the account that submitted the AWS Support case.

\n " }, "timeCreated": { "shape_name": "TimeCreated", "type": "string", "documentation": "\n

Time the support case was created.

\n " } }, "documentation": "\n

Object that exposes the fields used by a communication for an AWS Support case.

\n " }, "documentation": "\n

Contains a list of Communications objects.

\n " }, "nextToken": { "shape_name": "NextToken", "type": "string", "documentation": "\n

Defines a resumption point for pagination.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " }, { "shape_name": "CaseIdNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Error returned when the request does not return a case for the CaseId submitted.

\n " } }, "documentation": "\n

Returned when the CaseId requested could not be located.

\n " } ], "documentation": "\n

This action returns communications regarding the support case. You can use the AfterTime and BeforeTime parameters to filter by date. The CaseId parameter enables you to identify a specific case by its CaseId number.

\n

The MaxResults and NextToken parameters enable you to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination.

\n " }, "DescribeServices": { "name": "DescribeServices", "input": { "shape_name": "DescribeServicesRequest", "type": "structure", "members": { "serviceCodeList": { "shape_name": "ServiceCodeList", "type": "list", "members": { "shape_name": "ServiceCode", "type": "string", "pattern": "[0-9a-z\\-_]+", "documentation": null }, "min_length": 0, "max_length": 100, "documentation": "\n

List in JSON format of service codes available for AWS services.

\n " }, "language": { "shape_name": "Language", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "DescribeServicesResponse", "type": "structure", "members": { "services": { "shape_name": "ServiceList", "type": "list", "members": { "shape_name": "Service", "type": "structure", "members": { "code": { "shape_name": "ServiceCode", "type": "string", "documentation": "\n

JSON-formatted string that represents a code for an AWS service returned by DescribeServices response. Has a corrsponding name represented by a service.name string.

\n " }, "name": { "shape_name": "ServiceName", "type": "string", "documentation": "\n

JSON-formatted string that represents the friendly name for an AWS service. Has a corresponding code reprsented by a Service.code string.

\n " }, "categories": { "shape_name": "CategoryList", "type": "list", "members": { "shape_name": "Category", "type": "structure", "members": { "code": { "shape_name": "CategoryCode", "type": "string", "documentation": "\n

Category code for the support case.

\n " }, "name": { "shape_name": "CategoryName", "type": "string", "documentation": "\n

Category name for the support case.

\n " } }, "documentation": "\n

JSON-formatted name/value pair that represents the name and category of problem selected from the DescribeServices response for each AWS service.

\n " }, "documentation": "\n

JSON-formatted list of categories that describe the type of support issue a case describes. Categories are strings that represent a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

\n " } }, "documentation": "\n

JSON-formatted object that represents an AWS Service returned by the DescribeServices action.

\n " }, "documentation": "\n

JSON-formatted list of AWS services.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

\n \n

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Open a new case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

\n \n " }, "DescribeSeverityLevels": { "name": "DescribeSeverityLevels", "input": { "shape_name": "DescribeSeverityLevelsRequest", "type": "structure", "members": { "language": { "shape_name": "Language", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " } }, "documentation": " \n " }, "output": { "shape_name": "DescribeSeverityLevelsResponse", "type": "structure", "members": { "severityLevels": { "shape_name": "SeverityLevelsList", "type": "list", "members": { "shape_name": "SeverityLevel", "type": "structure", "members": { "code": { "shape_name": "SeverityLevelCode", "type": "string", "documentation": "\n

String that represents one of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in the string SeverityLevel.name.

\n " }, "name": { "shape_name": "SeverityLevelName", "type": "string", "documentation": "\n

Name of severity levels that correspond to the severity level codes.

\n " } }, "documentation": "\n

JSON-formatted pair of strings consisting of a code and name that represent a severity level that can be applied to a support case.

\n " }, "documentation": "\n

List of available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

This action returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

\n \n " }, "DescribeTrustedAdvisorCheckRefreshStatuses": { "name": "DescribeTrustedAdvisorCheckRefreshStatuses", "input": { "shape_name": "DescribeTrustedAdvisorCheckRefreshStatusesRequest", "type": "structure", "members": { "checkIds": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

List of the CheckId values for the Trusted Advisor checks for which you want to refresh the status. You obtain the CheckId values by calling DescribeTrustedAdvisorChecks.

\n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "DescribeTrustedAdvisorCheckRefreshStatusesResponse", "type": "structure", "members": { "statuses": { "shape_name": "TrustedAdvisorCheckRefreshStatusList", "type": "list", "members": { "shape_name": "TrustedAdvisorCheckRefreshStatus", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": "\n

String that specifies the checkId value of the Trusted Advisor check.

\n ", "required": true }, "status": { "shape_name": "String", "type": "string", "documentation": "\n

Indicates the status of the Trusted Advisor check for which a refresh has been requested.

\n ", "required": true }, "millisUntilNextRefreshable": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates the time in milliseconds until a call to RefreshTrustedAdvisorCheck can trigger a refresh.

\n ", "required": true } }, "documentation": "\n

Contains the fields that indicate the statuses Trusted Advisor checks for which refreshes have been requested.

\n " }, "documentation": "\n

List of the statuses of the Trusted Advisor checks you've specified for refresh. Status values are:

\n \n ", "required": true } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

Returns the status of all refresh requests Trusted Advisor checks called using RefreshTrustedAdvisorCheck.

\n " }, "DescribeTrustedAdvisorCheckResult": { "name": "DescribeTrustedAdvisorCheckResult", "input": { "shape_name": "DescribeTrustedAdvisorCheckResultRequest", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": " \n ", "required": true }, "language": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "DescribeTrustedAdvisorCheckResultResponse", "type": "structure", "members": { "result": { "shape_name": "TrustedAdvisorCheckResult", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier for a Trusted Advisor check.

\n ", "required": true }, "timestamp": { "shape_name": "String", "type": "string", "documentation": "\n

Time at which Trusted Advisor ran the check.

\n ", "required": true }, "status": { "shape_name": "String", "type": "string", "documentation": "\n

Overall status of the check. Status values are \"ok,\" \"warning,\" \"error,\" or \"not_available.\"

\n ", "required": true }, "resourcesSummary": { "shape_name": "TrustedAdvisorResourcesSummary", "type": "structure", "members": { "resourcesProcessed": { "shape_name": "Long", "type": "long", "documentation": "\n

Reports the number of AWS resources that were analyzed in your Trusted Advisor check.

\n ", "required": true }, "resourcesFlagged": { "shape_name": "Long", "type": "long", "documentation": "\n

Reports the number of AWS resources that were flagged in your Trusted Advisor check.

\n ", "required": true }, "resourcesIgnored": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates the number of resources ignored by Trusted Advisor due to unavailability of information.

\n ", "required": true }, "resourcesSuppressed": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.

\n ", "required": true } }, "documentation": "\n

JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

\n ", "required": true }, "categorySpecificSummary": { "shape_name": "TrustedAdvisorCategorySpecificSummary", "type": "structure", "members": { "costOptimizing": { "shape_name": "TrustedAdvisorCostOptimizingSummary", "type": "structure", "members": { "estimatedMonthlySavings": { "shape_name": "Double", "type": "double", "documentation": "\n

Reports the estimated monthly savings determined by the Trusted Advisor check for your account.

\n ", "required": true }, "estimatedPercentMonthlySavings": { "shape_name": "Double", "type": "double", "documentation": "\n

Reports the estimated percentage of savings determined for your account by the Trusted Advisor check.

\n ", "required": true } }, "documentation": "\n

Corresponds to the Cost Optimizing tab on the AWS Support Center Trusted Advisor page. This field is only available to checks in the Cost Optimizing category.

\n " } }, "documentation": "\n

Reports summaries for each Trusted Advisor category. Only the category cost optimizing is currently supported. The other categories are security, fault tolerance, and performance.

\n ", "required": true }, "flaggedResources": { "shape_name": "TrustedAdvisorResourceDetailList", "type": "list", "members": { "shape_name": "TrustedAdvisorResourceDetail", "type": "structure", "members": { "status": { "shape_name": "String", "type": "string", "documentation": "\n

Status code for the resource identified in the Trusted Advisor check.

\n ", "required": true }, "region": { "shape_name": "String", "type": "string", "documentation": "\n

AWS region in which the identified resource is located.

\n ", "required": true }, "resourceId": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier for the identified resource.

\n ", "required": true }, "isSuppressed": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.

\n " }, "metadata": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks.

\n ", "required": true } }, "documentation": "\n

Structure that contains information about the resource to which the Trusted Advisor check pertains.

\n " }, "documentation": "\n

List of AWS resources flagged by the Trusted Advisor check.

\n ", "required": true } }, "documentation": "\n

Returns a TrustedAdvisorCheckResult object.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

This action responds with the results of a Trusted Advisor check. Once you have obtained the list of available Trusted Advisor checks by calling DescribeTrustedAdvisorChecks, you specify the CheckId for the check you want to retrieve from AWS Support.

\n

The response for this action contains a JSON-formatted TrustedAdvisorCheckResult object

, which is a container for the following three objects:

\n
    \n
  1. TrustedAdvisorCategorySpecificSummary
    2. \n
  2. TrustedAdvisorResourceDetail
    3. \n
  3. TrustedAdvisorResourcesSummary
    4. \n
\n

In addition, the response contains the following fields:

\n
    \n
  1. \nStatus. Overall status of the check.
    2. \n
  2. \nTimestamp. Time at which Trusted Advisor last ran the check.
    3. \n
  3. \nCheckId. Unique identifier for the specific check returned by the request.
    4. \n
\n " }, "DescribeTrustedAdvisorCheckSummaries": { "name": "DescribeTrustedAdvisorCheckSummaries", "input": { "shape_name": "DescribeTrustedAdvisorCheckSummariesRequest", "type": "structure", "members": { "checkIds": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

Unique identifier for a Trusted Advisor check.

\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "DescribeTrustedAdvisorCheckSummariesResponse", "type": "structure", "members": { "summaries": { "shape_name": "TrustedAdvisorCheckSummaryList", "type": "list", "members": { "shape_name": "TrustedAdvisorCheckSummary", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier for a Trusted Advisor check.

\n ", "required": true }, "timestamp": { "shape_name": "String", "type": "string", "documentation": "\n

\n ", "required": true }, "status": { "shape_name": "String", "type": "string", "documentation": "\n

Overall status of the Trusted Advisor check.

\n ", "required": true }, "hasFlaggedResources": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n

Indicates that the Trusted Advisor check returned flagged resources.

\n " }, "resourcesSummary": { "shape_name": "TrustedAdvisorResourcesSummary", "type": "structure", "members": { "resourcesProcessed": { "shape_name": "Long", "type": "long", "documentation": "\n

Reports the number of AWS resources that were analyzed in your Trusted Advisor check.

\n ", "required": true }, "resourcesFlagged": { "shape_name": "Long", "type": "long", "documentation": "\n

Reports the number of AWS resources that were flagged in your Trusted Advisor check.

\n ", "required": true }, "resourcesIgnored": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates the number of resources ignored by Trusted Advisor due to unavailability of information.

\n ", "required": true }, "resourcesSuppressed": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates whether the specified AWS resource has had its participation in Trusted Advisor checks suppressed.

\n ", "required": true } }, "documentation": "\n

JSON-formatted object that lists details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

\n ", "required": true }, "categorySpecificSummary": { "shape_name": "TrustedAdvisorCategorySpecificSummary", "type": "structure", "members": { "costOptimizing": { "shape_name": "TrustedAdvisorCostOptimizingSummary", "type": "structure", "members": { "estimatedMonthlySavings": { "shape_name": "Double", "type": "double", "documentation": "\n

Reports the estimated monthly savings determined by the Trusted Advisor check for your account.

\n ", "required": true }, "estimatedPercentMonthlySavings": { "shape_name": "Double", "type": "double", "documentation": "\n

Reports the estimated percentage of savings determined for your account by the Trusted Advisor check.

\n ", "required": true } }, "documentation": "\n

Corresponds to the Cost Optimizing tab on the AWS Support Center Trusted Advisor page. This field is only available to checks in the Cost Optimizing category.

\n " } }, "documentation": "\n

Reports the results of a Trusted Advisor check by category. Only Cost Optimizing is currently supported.

\n ", "required": true } }, "documentation": "\n

Reports a summary of the Trusted Advisor check. This object contains the following child objects that report summary information about specific checks by category and resource:

\n \n " }, "documentation": "\n

List of TrustedAdvisorCheckSummary objects returned by the DescribeTrustedAdvisorCheckSummaries request.

\n ", "required": true } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

This action enables you to get the latest summaries for Trusted Advisor checks that you specify in your request. You submit the list of Trusted Advisor checks for which you want summaries. You obtain these CheckIds by submitting a DescribeTrustedAdvisorChecks request.

\n

The response body contains an array of TrustedAdvisorCheckSummary objects.

\n \n \n " }, "DescribeTrustedAdvisorChecks": { "name": "DescribeTrustedAdvisorChecks", "input": { "shape_name": "DescribeTrustedAdvisorChecksRequest", "type": "structure", "members": { "language": { "shape_name": "String", "type": "string", "documentation": "\n

Specifies the ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English and Japanese, for which the codes are en and ja, respectively. Language parameters must be passed explicitly for operations that take them.

\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "DescribeTrustedAdvisorChecksResponse", "type": "structure", "members": { "checks": { "shape_name": "TrustedAdvisorCheckList", "type": "list", "members": { "shape_name": "TrustedAdvisorCheckDescription", "type": "structure", "members": { "id": { "shape_name": "String", "type": "string", "documentation": "\n

Unique identifier for a specific Trusted Advisor check description.

\n ", "required": true }, "name": { "shape_name": "String", "type": "string", "documentation": "\n

Display name for the Trusted Advisor check. Corresponds to the display name for the check in the Trusted Advisor user interface.

\n ", "required": true }, "description": { "shape_name": "String", "type": "string", "documentation": "\n

Description of the Trusted Advisor check.

\n ", "required": true }, "category": { "shape_name": "String", "type": "string", "documentation": "\n

Category to which the Trusted Advisor check belongs.

\n ", "required": true }, "metadata": { "shape_name": "StringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null }, "documentation": "\n

List of metadata returned in TrustedAdvisorResourceDetail objects for a Trusted Advisor check.

\n ", "required": true } }, "documentation": "\n

Description of each check returned by DescribeTrustedAdvisorChecks.

\n " }, "documentation": "\n

List of the checks returned by calling DescribeTrustedAdvisorChecks

\n ", "required": true } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

This action enables you to get a list of the available Trusted Advisor checks. You must specify a language code. English (\"en\") and Japanese (\"jp\") are currently supported. The response contains a list of TrustedAdvisorCheckDescription objects.

\n " }, "RefreshTrustedAdvisorCheck": { "name": "RefreshTrustedAdvisorCheck", "input": { "shape_name": "RefreshTrustedAdvisorCheckRequest", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": "\n \n ", "required": true } }, "documentation": "\n \n " }, "output": { "shape_name": "RefreshTrustedAdvisorCheckResponse", "type": "structure", "members": { "status": { "shape_name": "TrustedAdvisorCheckRefreshStatus", "type": "structure", "members": { "checkId": { "shape_name": "String", "type": "string", "documentation": "\n

String that specifies the checkId value of the Trusted Advisor check.

\n ", "required": true }, "status": { "shape_name": "String", "type": "string", "documentation": "\n

Indicates the status of the Trusted Advisor check for which a refresh has been requested.

\n ", "required": true }, "millisUntilNextRefreshable": { "shape_name": "Long", "type": "long", "documentation": "\n

Indicates the time in milliseconds until a call to RefreshTrustedAdvisorCheck can trigger a refresh.

\n ", "required": true } }, "documentation": "\n

Returns the overall status of the RefreshTrustedAdvisorCheck call.

\n ", "required": true } }, "documentation": "\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " } ], "documentation": "\n

This action enables you to query the service to request a refresh for a specific Trusted Advisor check. Your request body contains a CheckId for which you are querying. The response body contains a RefreshTrustedAdvisorCheckResult object containing Status and TimeUntilNextRefresh fields.

\n " }, "ResolveCase": { "name": "ResolveCase", "input": { "shape_name": "ResolveCaseRequest", "type": "structure", "members": { "caseId": { "shape_name": "CaseId", "type": "string", "documentation": "\n

String that indicates the AWS Support caseID requested or returned in the call. The caseID is an alphanumeric string formatted as shown in this example CaseId: case-12345678910-2013-c4c1d2bf33c5cf47

\n " } }, "documentation": "\n \n " }, "output": { "shape_name": "ResolveCaseResponse", "type": "structure", "members": { "initialCaseStatus": { "shape_name": "CaseStatus", "type": "string", "documentation": "\n

Status of the case when the ResolveCase request was sent.

\n " }, "finalCaseStatus": { "shape_name": "CaseStatus", "type": "string", "documentation": "\n

Status of the case after the ResolveCase request was processed.

\n " } }, "documentation": "\n

Returns the objects or data listed below if successful. Otherwise, returns an error.

\n " }, "errors": [ { "shape_name": "InternalServerError", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Returns HTTP error 500.

\n " } }, "documentation": "\n

Returns HTTP error 500.

\n " }, { "shape_name": "CaseIdNotFound", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

Error returned when the request does not return a case for the CaseId submitted.

\n " } }, "documentation": "\n

Returned when the CaseId requested could not be located.

\n " } ], "documentation": "\n \n

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

\n " } }, "global_endpoint": "support.us-east-1.amazonaws.com", "metadata": { "regions": { "us-east-1": "https://support.us-east-1.amazonaws.com" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } } } } } }botocore-0.29.0/botocore/data/aws/swf.json0000644000175000017500000312412712254746566017754 0ustar takakitakaki{ "api_version": "2012-01-25", "type": "json", "json_version": 1.0, "target_prefix": "SimpleWorkflowService", "signature_version": "v4", "timestamp_format": "unixTimestamp", "service_full_name": "Amazon Simple Workflow Service", "service_abbreviation": "Amazon SWF", "endpoint_prefix": "swf", "documentation": "\n Amazon Simple Workflow Service\n\n

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate\n work across distributed components. In Amazon SWF, a task represents a logical unit of\n work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing\n intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

\n\n

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about\n underlying complexities such as tracking their progress and maintaining their state.

\n\n

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see\n the Amazon SWF Developer Guide.

\n ", "operations": { "CountClosedWorkflowExecutions": { "name": "CountClosedWorkflowExecutions", "input": { "shape_name": "CountClosedWorkflowExecutionsInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The name of the domain containing the workflow executions to count.

\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n If specified, only workflow executions that meet the start time criteria of the filter are counted.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both.\n " }, "closeTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n If specified, only workflow executions that meet the close time criteria of the filter are counted.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both.\n " }, "executionFilter": { "shape_name": "WorkflowExecutionFilter", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId to pass of match the criteria of this filter.\n

\n ", "required": true } }, "documentation": "\n

If specified, only workflow executions matching the WorkflowId in the filter are counted.

\n closeStatusFilter, executionFilter, typeFilter and\n tagFilter are mutually exclusive. You can specify at most one of these in a request.\n " }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Name of the workflow type.\n This field is required.\n

\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n

\n Version of the workflow type.\n

\n " } }, "documentation": "\n

\n If specified, indicates the type of the workflow executions to be counted.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "tagFilter": { "shape_name": "TagFilter", "type": "structure", "members": { "tag": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only executions that have a tag that matches the filter are counted.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "closeStatusFilter": { "shape_name": "CloseStatusFilter", "type": "structure", "members": { "status": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n

\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only workflow executions that match this close status are counted.\n This filter has an affect only if executionStatus\n is specified as CLOSED.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The number of workflow executions.\n

\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n

\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

\n " } }, "documentation": "\n

\n Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

Returns the number of closed workflow executions within the given domain that meet the specified filtering\n criteria.

\n\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n\n \n\n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside\n the specified constraints, the action fails by throwing OperationNotPermitted. For details and\n example IAM policies, see Using IAM to Manage Access to\n Amazon SWF Workflows.

\n\n \n \n CountClosedWorkflowExecutions Example\n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:42:47 GMT\n X-Amz-Target: SimpleWorkflowService.CountClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=jFS74utjeATV7vj72CWdLToPCKW0RQse6OEDkafB+SA=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 157\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\n \"domain\": \"867530901\",\n \"closeTimeFilter\": {\"oldestDate\": 1325376070, \"latestDate\": 1356998399},\n \"closeStatusFilter\": {\"status\": \"TIMED_OUT\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 9bfad387-3f22-11e1-9914-a356b6ea8bdf\n\n { \"count\":3, \"truncated\":false }\n \n \n \n " }, "CountOpenWorkflowExecutions": { "name": "CountOpenWorkflowExecutions", "input": { "shape_name": "CountOpenWorkflowExecutionsInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the workflow executions to count.\n

\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n Specifies the start time criteria that workflow executions must meet in order to be counted.\n

\n ", "required": true }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Name of the workflow type.\n This field is required.\n

\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n

\n Version of the workflow type.\n

\n " } }, "documentation": "\n

\n Specifies the type of the workflow executions to be counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "tagFilter": { "shape_name": "TagFilter", "type": "structure", "members": { "tag": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only executions that have a tag that matches the filter are counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "executionFilter": { "shape_name": "WorkflowExecutionFilter", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId to pass of match the criteria of this filter.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only workflow executions matching the WorkflowId in the filter are counted.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The number of workflow executions.\n

\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n

\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

\n " } }, "documentation": "\n

\n Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns the number of open workflow executions within the given domain that meet the specified filtering\n criteria.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n CountOpenWorkflowExecutions Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:13:29 GMT\n X-Amz-Target: SimpleWorkflowService.CountOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=3v6shiGzWukq4KiX/5HFMIUF/w5qajhW4dp+6AKyOtY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 5ea6789e-3f05-11e1-9e8f-57bb03e21482\n\n {\"count\":1,\"truncated\":false}\n \n \n \n " }, "CountPendingActivityTasks": { "name": "CountPendingActivityTasks", "input": { "shape_name": "CountPendingActivityTasksInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain that contains the task list.\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "PendingTaskCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The number of tasks in the task list.\n

\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n

\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

\n " } }, "documentation": "\n

\n Contains the count of tasks in a task list.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no activity task was ever scheduled in then 0 will be returned.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n CountPendingActivityTasks Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:29:28 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingActivityTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=eCNiyyl5qmP0gGQ0hM8LqeRzxEvVZ0LAjE4oxVzzk9w=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4b977c76-3ff2-11e1-a23a-99d60383ae71\n\n {\"count\":1,\"truncated\":false}\n \n\n \n\n \n\n " }, "CountPendingDecisionTasks": { "name": "CountPendingDecisionTasks", "input": { "shape_name": "CountPendingDecisionTasksInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain that contains the task list.\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "PendingTaskCount", "type": "structure", "members": { "count": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The number of tasks in the task list.\n

\n ", "required": true }, "truncated": { "shape_name": "Truncated", "type": "boolean", "documentation": "\n

\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n

\n " } }, "documentation": "\n

\n Contains the count of tasks in a task list.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no decision task was ever scheduled in then 0 will be returned.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n\n \n\n CountPendingDecisionTasks Example \n\n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:25:57 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingDecisionTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=i9tUkWnZBLfn/T6BOymajCtwArAll6Stuh1x2C4dbsE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4718a364-3fd0-11e1-9914-a356b6ea8bdf\n\n {\"count\": 2,\n \"truncated\": false}\n \n\n \n\n \n\n " }, "DeprecateActivityType": { "name": "DeprecateActivityType", "input": { "shape_name": "DeprecateActivityTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the activity type is registered.\n

\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The activity type to deprecate.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the specified activity or workflow type was already deprecated.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Deprecates the specified activity type.\n After an activity type has been deprecated, you cannot create new tasks of that activity type.\n Tasks of this type that were scheduled before the type was deprecated will continue to run.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n DeprecateActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:01:06 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iX/mNMtNH6IaSNwfZq9hHOhDlLnp7buuj9tO93kRIrQ=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 191ee17e-3fff-11e1-a23a-99d60383ae71\n \n \n \n " }, "DeprecateDomain": { "name": "DeprecateDomain", "input": { "shape_name": "DeprecateDomainInput", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain to deprecate.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "DomainDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the specified domain has been deprecated.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions\n or register new types. However, you can still use visibility actions on this domain.\n Deprecating a domain also deprecates all activity and workflow types registered in the domain.\n Executions that were started before the domain was deprecated will continue to run.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n DeprecateDomain Example\n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 05:07:47 GMT\nX-Amz-Target: SimpleWorkflowService.DeprecateDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BkJDtbH9uZvrarqXTkBEYuYHO7PPygRI8ykV29Dz/5M=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 0800c01a-4000-11e1-9914-a356b6ea8bdf\n\n\n \n \n " }, "DeprecateWorkflowType": { "name": "DeprecateWorkflowType", "input": { "shape_name": "DeprecateWorkflowTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the workflow type is registered.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type to deprecate.\n

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the specified activity or workflow type was already deprecated.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions\n of that type. Executions that were started before the type was deprecated will continue to run.\n A deprecated workflow type may still be used when calling visibility actions.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n\n \n\n DeprecateWorkflowType Example \n\n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:04:47 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BGrr1djQvp+YLq3ci2ffpK8KWhZm/PakBL2fFhc3zds=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 9c8d6d3b-3fff-11e1-9e8f-57bb03e21482\n \n\n \n\n \n\n " }, "DescribeActivityType": { "name": "DescribeActivityType", "input": { "shape_name": "DescribeActivityTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the activity type is registered.\n

\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The activity type to describe.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "ActivityTypeDetail", "type": "structure", "members": { "typeInfo": { "shape_name": "ActivityTypeInfo", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The ActivityType type structure representing the activity type.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The current status of the activity type.\n

\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the activity type provided in RegisterActivityType.\n

\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date and time this activity type was created through RegisterActivityType.\n

\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n If DEPRECATED, the date and time DeprecateActivityType was called.\n

\n " } }, "documentation": "\n

\n General information about the activity type.\n

\n

\n The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.\n

\n \n ", "required": true }, "configuration": { "shape_name": "ActivityTypeConfiguration", "type": "structure", "members": { "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum duration for tasks of an activity type specified when\n registering the activity type. You can\n override this default when scheduling a task through the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskHeartbeatTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum time, specified when registering the activity type,\n before which a worker processing a task must report progress by\n calling RecordActivityTaskHeartbeat.\n You can override this default when scheduling a task through the ScheduleActivityTask Decision.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker\n receives an UnknownResource fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The optional default task list specified for this activity type at registration. This default task list is used\n if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.\n You can override this default when scheduling a task through the ScheduleActivityTask Decision.\n

\n " }, "defaultTaskScheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum duration, specified when registering the activity type,\n that a task of an activity type can wait before being assigned to a worker.\n You can override this default when scheduling a task through the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskScheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum duration, specified when registering the activity type,\n for tasks of this activity type.\n You can override this default when scheduling a task through the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " } }, "documentation": "\n

\n The configuration settings registered with the activity type.\n

\n ", "required": true } }, "documentation": "\n

\n Detailed information about an activity type.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns information about the specified activity type. This includes\n configuration settings provided at registration time as well as other general information about the type.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n DescribeActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 03:04:10 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=XiGRwOZNLt+ic3VBWvIlRGdcFcRJVSE8J7zyZLU3oXg=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 387\n Content-Type: application/json\n x-amzn-RequestId: 98d56ff5-3f25-11e1-9b11-7182192d0b57\n\n {\"configuration\":\n {\"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToCloseTimeout\": \"900\",\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n }\n \n \n \n " }, "DescribeDomain": { "name": "DescribeDomain", "input": { "shape_name": "DescribeDomainInput", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain to describe.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "DomainDetail", "type": "structure", "members": { "domainInfo": { "shape_name": "DomainInfo", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain. This name is unique within the account.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The status of the domain:\n

\n \n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the domain provided through RegisterDomain.\n

\n " } }, "documentation": "\n

\n Contains general information about a domain.\n

\n ", "required": true }, "configuration": { "shape_name": "DomainConfiguration", "type": "structure", "members": { "workflowExecutionRetentionPeriodInDays": { "shape_name": "DurationInDays", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The retention period for workflow executions in this domain.\n

\n ", "required": true } }, "documentation": "\n

\n Contains the configuration settings of a domain.\n

\n ", "required": true } }, "documentation": "\n

\n Contains details of a domain.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns information about the specified domain including description and status.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n\n \n DescribeDomain Example \n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:13:33 GMT\nX-Amz-Target: SimpleWorkflowService.DescribeDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=IFJtq3M366CHqMlTpyqYqd9z0ChCoKDC5SCJBsLifu4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 137\nContent-Type: application/json\nx-amzn-RequestId: e86a6779-3f26-11e1-9a27-0760db01a4a8\n\n{\"configuration\":\n {\"workflowExecutionRetentionPeriodInDays\": \"60\"},\n \"domainInfo\":\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"}\n}\n\n\n \n\n\n" }, "DescribeWorkflowExecution": { "name": "DescribeWorkflowExecution", "input": { "shape_name": "DescribeWorkflowExecutionInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the workflow execution.\n

\n ", "required": true }, "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution to describe.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionDetail", "type": "structure", "members": { "executionInfo": { "shape_name": "WorkflowExecutionInfo", "type": "structure", "members": { "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution this information is about.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow execution.\n

\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the execution was started.\n

\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n

\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n

\n The current status of the execution.\n

\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n

\n If the execution status is closed then this specifies how the execution was closed:

\n \n " }, "parent": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n

\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n

\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n

\n Set to true if a cancellation is requested for this workflow execution.\n

\n " } }, "documentation": "\n

\n Information about the workflow execution.\n

\n ", "required": true }, "executionConfiguration": { "shape_name": "WorkflowExecutionConfiguration", "type": "structure", "members": { "taskStartToCloseTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The maximum duration allowed for decision tasks for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n ", "required": true }, "executionStartToCloseTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The total duration for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The task list used for the decision tasks generated for this workflow execution.\n

\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n The supported child policies are:

\n \n ", "required": true } }, "documentation": "\n

\n The configuration settings for this workflow execution including timeout values, tasklist etc.\n

\n ", "required": true }, "openCounts": { "shape_name": "WorkflowExecutionOpenCounts", "type": "structure", "members": { "openActivityTasks": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The count of activity tasks whose status is OPEN.\n

\n ", "required": true }, "openDecisionTasks": { "shape_name": "OpenDecisionTasksCount", "type": "integer", "min_length": 0, "max_length": 1, "documentation": "\n

\n The count of decision tasks whose status is OPEN.\n A workflow execution can have at most one open decision task.\n

\n ", "required": true }, "openTimers": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The count of timers started by this workflow execution that have not fired yet.\n

\n ", "required": true }, "openChildWorkflowExecutions": { "shape_name": "Count", "type": "integer", "min_length": 0, "documentation": "\n

\n The count of child workflow executions whose status is OPEN.\n

\n ", "required": true } }, "documentation": "\n

\n The number of tasks for this workflow execution. This includes open and closed tasks of all types.\n

\n ", "required": true }, "latestActivityTaskTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the\n workflow has not made progress for an unusually long period of time and might require a corrective action.\n

\n " }, "latestExecutionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The latest executionContext provided by the decider for this workflow execution.\n A decider can provide an executionContext, which is a free form string, when closing a decision task\n using RespondDecisionTaskCompleted.\n

\n " } }, "documentation": "\n

\n Contains details about a workflow execution.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns information about the specified workflow execution including its type and some statistics.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n DescribeWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:05:18 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ufQVcSkfUyGPLiS8xbkEBqEc2PmEEE/3Lb9Kr8yozs8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 127\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\"}\n }\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 577\n Content-Type: application/json\n x-amzn-RequestId: 5f85ef79-3f1d-11e1-9e8f-57bb03e21482\n\n {\"executionConfiguration\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\"},\n \"executionInfo\":\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326592619.474,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n \"openCounts\":\n {\"openActivityTasks\": 0,\n \"openChildWorkflowExecutions\": 0,\n \"openDecisionTasks\": 1,\n \"openTimers\": 0}\n }\n \n \n \n " }, "DescribeWorkflowType": { "name": "DescribeWorkflowType", "input": { "shape_name": "DescribeWorkflowTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which this workflow type is registered.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type to describe.\n

\n ", "required": true } }, "documentation": null }, "output": { "shape_name": "WorkflowTypeDetail", "type": "structure", "members": { "typeInfo": { "shape_name": "WorkflowTypeInfo", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type this information is about.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The current status of the workflow type.\n

\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the type registered through RegisterWorkflowType.\n

\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date when this type was registered.\n

\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n

\n " } }, "documentation": "\n

General information about the workflow type.

\n

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

\n \n ", "required": true }, "configuration": { "shape_name": "WorkflowTypeConfiguration", "type": "structure", "members": { "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum duration, specified when registering the workflow type, that a decision task for executions\n of this workflow type might take before returning completion or\n failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If\n the decider eventually reports a completion or failure, it is ignored.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultExecutionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The optional default maximum duration, specified when registering the workflow type, for executions of this workflow type.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The optional default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution Decision.\n

\n " }, "defaultChildPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The optional default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution Decision.\n The supported child policies are:

\n \n " } }, "documentation": "\n

Configuration settings of the workflow type registered through RegisterWorkflowType

\n ", "required": true } }, "documentation": "\n

Contains details about a workflow type.

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns information about the specified workflow type. This includes\n configuration settings specified when the type was registered and other information\n such as creation date, current status, etc.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n DescribeWorkflowType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:40:40 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iGt8t83OmrURqu0pKYbcW6mNdjXbFomevCBPUPQEbaM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 348\n Content-Type: application/json\n x-amzn-RequestId: f35a8e7f-3fc9-11e1-a23a-99d60383ae71\n\n {\"configuration\":\n {\"defaultChildPolicy\": \"TERMINATE\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n \n \n \n " }, "GetWorkflowExecutionHistory": { "name": "GetWorkflowExecutionHistory", "input": { "shape_name": "GetWorkflowExecutionHistoryInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the workflow execution.\n

\n ", "required": true }, "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n Specifies the workflow execution for which to return the history.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If a NextPageToken is returned, the result has more than one pages. To get the next page,\n repeat the call and specify the nextPageToken with all other arguments unchanged.\n

\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n Specifies the maximum number of history events returned in one page.\n The next page in the result is identified by the NextPageToken returned.\n By default 100 history events are returned in a page but the caller can override this\n value to a page size smaller than the default. You cannot specify a page size\n larger than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimeStamp of the events.\n

\n " } }, "documentation": null }, "output": { "shape_name": "History", "type": "structure", "members": { "events": { "shape_name": "HistoryEventList", "type": "list", "members": { "shape_name": "HistoryEvent", "type": "structure", "members": { "eventTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date and time when the event occurred.\n

\n ", "required": true }, "eventType": { "shape_name": "EventType", "type": "string", "enum": [ "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested" ], "documentation": "\n

\n The type of the history event.\n

\n ", "required": true }, "eventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n

\n ", "required": true }, "workflowExecutionStartedEventAttributes": { "shape_name": "WorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the workflow execution (if any).\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration of decision tasks for this workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\n The supported child policies are:\n

\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list for scheduling the decision tasks for this workflow execution.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type of this execution.\n

\n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n

\n " }, "continuedExecutionRunId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then\n it contains the runId of the previous workflow execution that was closed and continued as this execution.\n

\n " }, "parentWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n

\n " }, "parentInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCompletedEventAttributes": { "shape_name": "WorkflowExecutionCompletedEventAttributes", "type": "structure", "members": { "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result produced by the workflow execution upon successful completion.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "completeWorkflowExecutionFailedEventAttributes": { "shape_name": "CompleteWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "CompleteWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CompleteWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionFailedEventAttributes": { "shape_name": "WorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The descriptive reason provided for the failure (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "failWorkflowExecutionFailedEventAttributes": { "shape_name": "FailWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "FailWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type FailWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionTimedOutEventAttributes": { "shape_name": "WorkflowExecutionTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of timeout that caused this event.\n

\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n

\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCanceledEventAttributes": { "shape_name": "WorkflowExecutionCanceledEventAttributes", "type": "structure", "members": { "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details for the cancellation (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "cancelWorkflowExecutionFailedEventAttributes": { "shape_name": "CancelWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "CancelWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CancelWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionContinuedAsNewEventAttributes": { "shape_name": "WorkflowExecutionContinuedAsNewEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the new workflow execution.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "newExecutionRunId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The runId of the new workflow execution.\n

\n ", "required": true }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The total duration allowed for the new workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a task list.\n

\n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration of decision tasks for the new workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

\n\n

The supported child policies are:

\n \n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with the new workflow execution.\n

\n " }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a workflow type.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionContinuedAsNew then this member is set and\n provides detailed information about the event. It is not set for other event types.\n

\n " }, "continueAsNewWorkflowExecutionFailedEventAttributes": { "shape_name": "ContinueAsNewWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "ContinueAsNewWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ContinueAsNewWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionTerminatedEventAttributes": { "shape_name": "WorkflowExecutionTerminatedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "TerminateReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason provided for the termination (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details provided for the termination (if any).\n

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:

\n \n ", "required": true }, "cause": { "shape_name": "WorkflowExecutionTerminatedCause", "type": "string", "enum": [ "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED" ], "documentation": "\n

\n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCancelRequestedEventAttributes": { "shape_name": "WorkflowExecutionCancelRequestedEventAttributes", "type": "structure", "members": { "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution for which the cancellation was requested.\n

\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " }, "cause": { "shape_name": "WorkflowExecutionCancelRequestedCause", "type": "string", "enum": [ "CHILD_POLICY_APPLIED" ], "documentation": "\n

\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCancelRequested then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskScheduledEventAttributes": { "shape_name": "DecisionTaskScheduledEventAttributes", "type": "structure", "members": { "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list in which the decision task was scheduled.\n

\n ", "required": true }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " } }, "documentation": "\n

\n If the event is of type DecisionTaskScheduled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskStartedEventAttributes": { "shape_name": "DecisionTaskStartedEventAttributes", "type": "structure", "members": { "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskCompletedEventAttributes": { "shape_name": "DecisionTaskCompletedEventAttributes", "type": "structure", "members": { "executionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n User defined context for the workflow execution.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskTimedOutEventAttributes": { "shape_name": "DecisionTaskTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "DecisionTaskTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of timeout that expired before the decision task could be completed.\n

\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskScheduledEventAttributes": { "shape_name": "ActivityTaskScheduledEventAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the activity task.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique id of the activity task.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the activity task.\n

\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n

\n " }, "scheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time the activity task can wait to be assigned to a worker.\n

\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time for this activity task.\n

\n " }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time a worker may take to process the activity task.\n

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The task list in which the activity task has been scheduled.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "heartbeatTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum time before which the worker processing this task must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskScheduled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskStartedEventAttributes": { "shape_name": "ActivityTaskStartedEventAttributes", "type": "structure", "members": { "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCompletedEventAttributes": { "shape_name": "ActivityTaskCompletedEventAttributes", "type": "structure", "members": { "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The results of the activity task (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskFailedEventAttributes": { "shape_name": "ActivityTaskFailedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason provided for the failure (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskTimedOutEventAttributes": { "shape_name": "ActivityTaskTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "ActivityTaskTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT" ], "documentation": "\n

\n The type of the timeout that caused this event.\n

\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "details": { "shape_name": "LimitedData", "type": "string", "max_length": 2048, "documentation": "\n

\n Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCanceledEventAttributes": { "shape_name": "ActivityTaskCanceledEventAttributes", "type": "structure", "members": { "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the cancellation (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "latestCancelRequestedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n If set, contains the Id of the last ActivityTaskCancelRequested event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCancelRequestedEventAttributes": { "shape_name": "ActivityTaskCancelRequestedEventAttributes", "type": "structure", "members": { "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique ID of the task.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskcancelRequested then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionSignaledEventAttributes": { "shape_name": "WorkflowExecutionSignaledEventAttributes", "type": "structure", "members": { "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n

\n " }, "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n

\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflow decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionSignaled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "markerRecordedEventAttributes": { "shape_name": "MarkerRecordedEventAttributes", "type": "structure", "members": { "markerName": { "shape_name": "MarkerName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the marker.\n

\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the marker (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarker decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type MarkerRecorded then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "recordMarkerFailedEventAttributes": { "shape_name": "RecordMarkerFailedEventAttributes", "type": "structure", "members": { "markerName": { "shape_name": "MarkerName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The marker's name.

\n ", "required": true }, "cause": { "shape_name": "RecordMarkerFailedCause", "type": "string", "enum": [ "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarkerFailed decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerStartedEventAttributes": { "shape_name": "TimerStartedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that was started.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The duration of time after which the timer will fire.\n

\n

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerFiredEventAttributes": { "shape_name": "TimerFiredEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that fired.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerFired then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerCanceledEventAttributes": { "shape_name": "TimerCanceledEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that was canceled.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "startChildWorkflowExecutionInitiatedEventAttributes": { "shape_name": "StartChildWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the child workflow execution.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n

\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The inputs provided to the child workflow execution (if any).\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list used for the decision tasks of the child workflow execution.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the TerminateWorkflowExecution action or due to an expired timeout.

\n

The supported child policies are:

\n\n \n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration allowed for the decision tasks for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags to associated with the child workflow execution.\n

\n " } }, "documentation": "\n

\n If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionStartedEventAttributes": { "shape_name": "ChildWorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was started.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionCompletedEventAttributes": { "shape_name": "ChildWorkflowExecutionCompletedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was completed.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result of the child workflow execution (if any).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionFailedEventAttributes": { "shape_name": "ChildWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that failed.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason for the failure (if provided).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if provided).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionTimedOutEventAttributes": { "shape_name": "ChildWorkflowExecutionTimedOutEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that timed out.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of the timeout that caused the child workflow execution to time out.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionCanceledEventAttributes": { "shape_name": "ChildWorkflowExecutionCanceledEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was canceled.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the cancellation (if provided).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionTerminatedEventAttributes": { "shape_name": "ChildWorkflowExecutionTerminatedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was terminated.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "signalExternalWorkflowExecutionInitiatedEventAttributes": { "shape_name": "SignalExternalWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution to send the signal to.\n

\n " }, "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Input provided to the signal (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n

\n " } }, "documentation": "\n

\n If the event is of type SignalExternalWorkflowExecutionInitiated then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "externalWorkflowExecutionSignaledEventAttributes": { "shape_name": "ExternalWorkflowExecutionSignaledEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution that the signal was delivered to.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ExternalWorkflowExecutionSignaled then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "signalExternalWorkflowExecutionFailedEventAttributes": { "shape_name": "SignalExternalWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution that the signal was being delivered to.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution that the signal was being delivered to.\n

\n " }, "cause": { "shape_name": "SignalExternalWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

If the event is of type SignalExternalWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.

\n " }, "externalWorkflowExecutionCancelRequestedEventAttributes": { "shape_name": "ExternalWorkflowExecutionCancelRequestedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution to which the cancellation request was delivered.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ExternalWorkflowExecutionCancelRequested then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { "shape_name": "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution to be canceled.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution to be canceled.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " } }, "documentation": "\n

\n If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelExternalWorkflowExecutionFailedEventAttributes": { "shape_name": "RequestCancelExternalWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow to which the cancel request was to be delivered.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution.\n

\n " }, "cause": { "shape_name": "RequestCancelExternalWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

\n If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "scheduleActivityTaskFailedEventAttributes": { "shape_name": "ScheduleActivityTaskFailedEventAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The activity type provided in the ScheduleActivityTask decision that failed.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId provided in the ScheduleActivityTask decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "ScheduleActivityTaskFailedCause", "type": "string", "enum": [ "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ScheduleActivityTaskFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelActivityTaskFailedEventAttributes": { "shape_name": "RequestCancelActivityTaskFailedEventAttributes", "type": "structure", "members": { "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId provided in the RequestCancelActivityTask decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "RequestCancelActivityTaskFailedCause", "type": "string", "enum": [ "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

\n ", "required": true } }, "documentation": "\n

\n If the event is of type RequestCancelActivityTaskFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "startTimerFailedEventAttributes": { "shape_name": "StartTimerFailedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The timerId provided in the StartTimer decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "StartTimerFailedCause", "type": "string", "enum": [ "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type StartTimerFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "cancelTimerFailedEventAttributes": { "shape_name": "CancelTimerFailedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The timerId provided in the CancelTimer decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "CancelTimerFailedCause", "type": "string", "enum": [ "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n

\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CancelTimerFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "startChildWorkflowExecutionFailedEventAttributes": { "shape_name": "StartChildWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type provided in the StartChildWorkflowExecution Decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "StartChildWorkflowExecutionFailedCause", "type": "string", "enum": [ "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

\n If the event is of type StartChildWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " } }, "documentation": "\n

Event within a workflow execution. A history event can be one of these types:

\n \n " }, "documentation": "\n

\n The list of history events.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n The token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request\n with this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of\n the events related to all tasks and events in the life of the workflow execution.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns the history of the specified workflow execution.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n GetWorkflowExecutionHistory Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:44:00 GMT\n X-Amz-Target: SimpleWorkflowService.GetWorkflowExecutionHistory\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=90GENeUWJbEAMWuVI0dcWatHjltMWddXfLjl0MbNOzM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 175\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"d29e60b5-fa71-4276-a4be-948b0adcd20b\"},\n \"maximumPageSize\": 10,\n \"reverseOrder\": true}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 2942\n Content-Type: application/json\n x-amzn-RequestId: 5385723f-3ff4-11e1-b118-3bfa5e8e7fc3\n\n {\"events\":\n [\n {\"eventId\": 11,\n \"eventTimestamp\": 1326671603.102,\n \"eventType\": \"WorkflowExecutionTimedOut\",\n \"workflowExecutionTimedOutEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"timeoutType\": \"START_TO_CLOSE\"}\n },\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 10,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"activityTaskTimedOutEventAttributes\":\n {\"latestHeartbeatRecordedEventId\": 0,\n \"scheduledEventId\": 8,\n \"startedEventId\": 0,\n \"timeoutType\": \"SCHEDULE_TO_START\"},\n \"eventId\": 9,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"ActivityTaskTimedOut\"},\n {\"activityTaskScheduledEventAttributes\":\n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"control\": \"digital music\",\n \"decisionTaskCompletedEventId\": 7,\n \"heartbeatTimeout\": \"120\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 8,\n \"eventTimestamp\": 1326670266.115,\n \"eventType\": \"ActivityTaskScheduled\"},\n {\"decisionTaskCompletedEventAttributes\":\n {\"executionContext\": \"Black Friday\",\n \"scheduledEventId\": 5,\n \"startedEventId\": 6},\n \"eventId\": 7,\n \"eventTimestamp\": 1326670266.103,\n \"eventType\": \"DecisionTaskCompleted\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 5},\n \"eventId\": 6,\n \"eventTimestamp\": 1326670161.497,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 5,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"decisionTaskTimedOutEventAttributes\":\n {\"scheduledEventId\": 2,\n \"startedEventId\": 3,\n \"timeoutType\": \"START_TO_CLOSE\"},\n \"eventId\": 4,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskTimedOut\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326668152.648,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326668003.094,\n \"eventType\": \"DecisionTaskScheduled\"}\n ],\n \"nextPageToken\": \"AAAAKgAAAAEAAAAAAAAAATeTvAyvqlQz34ctbGhM5nglWmjzk0hGuHf0g4EO4CblQFku70ukjPgrAHy7Tnp7FaZ0okP8EEWnkfg8gi3Fqy/WVrXyxQaa525D31cIq1owXK21CKR6SQ0Job87G8SHvvqvP7yjLGHlHrRGZUCbJgeEuV4Rp/yW+vKhc8dJ54x7wvpQMwZ+ssG6stTyX26vu1gIDuspk13UrDZa4TbLOFdM0aAocHe3xklKMtD/B4ithem6BWm6CBl/UF7lMfNccwUYEityp1Kht/YrcD9zbJkt1FSt4Y6pgt0njAh4FKRO9nyRyvLmbvgtQXEIQz8hdbjwj3xE1+9ocYwXOCAhVkRsh3OD6F8KHilKfdwg4Xz1jtLXOh4lsCecNb8dS7J9hbRErRbw3rh1Sv415U2Ye23OEfF4Jv7JznpmEyzuq8d2bMyOLjAInQVFK4t1tPo5FAhzdICCXBhRq6Wkt++W9sRQXqqX/HTX5kNomHySZloylPuY5gL5zRj39frInfZk4EXWHwrI+18+erGIHO4nBQpMzO64dMP+A/KtVGCn59rAMmilD6wEE9rH8RuZ03Wkvm9yrJvjrI8/6358n8TMB8OcHoqILkMCAXYiIppnFlm+NWXVqxalHLKOrrNzEZM6qsz3Qj3HV1cpy9P7fnS9QAxrgsAYBoDmdOaFkS3ktAkRa0Sle8STfHi4zKbfIGS7rg==\"}\n \n \n \n " }, "ListActivityTypes": { "name": "ListActivityTypes", "input": { "shape_name": "ListActivityTypesInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the activity types have been registered.\n

\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n If specified, only lists the activity types that have this name.\n

\n " }, "registrationStatus": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n Specifies the registration status of the activity types to list.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextResultToken was returned, the results have\n more than one page. To get the next page of results, repeat the call with the nextPageToken\n and keep all other arguments unchanged.\n

\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name of the activity types.\n

\n " } }, "documentation": null }, "output": { "shape_name": "ActivityTypeInfos", "type": "structure", "members": { "typeInfos": { "shape_name": "ActivityTypeInfoList", "type": "list", "members": { "shape_name": "ActivityTypeInfo", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The ActivityType type structure representing the activity type.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The current status of the activity type.\n

\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the activity type provided in RegisterActivityType.\n

\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date and time this activity type was created through RegisterActivityType.\n

\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n If DEPRECATED, the date and time DeprecateActivityType was called.\n

\n " } }, "documentation": "\n

\n Detailed information about an activity type.\n

\n " }, "documentation": "\n

\n List of activity type information.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Contains a paginated list of activity type information structures.\n

\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " } ], "documentation": "\n

\n Returns information about all activities registered in the specified domain that match the\n specified name and registration status. The result includes information like creation date, current status of the activity, etc.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n ListActivityTypes Example \n \n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 171\n Content-Type: application/json\n x-amzn-RequestId: 11b6fbeb-3f25-11e1-9e8f-57bb03e21482\n\n {\"typeInfos\":\n [\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n ]\n }\n \n \n \n " }, "ListClosedWorkflowExecutions": { "name": "ListClosedWorkflowExecutions", "input": { "shape_name": "ListClosedWorkflowExecutionsInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain that contains the workflow executions to list.\n

\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their start times.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both.\n " }, "closeTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their close times.\n

\n startTimeFilter and closeTimeFilter are mutually exclusive.\n You must specify one of these in a request but not both.\n " }, "executionFilter": { "shape_name": "WorkflowExecutionFilter", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId to pass of match the criteria of this filter.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "closeStatusFilter": { "shape_name": "CloseStatusFilter", "type": "structure", "members": { "status": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n

\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only workflow executions that match this close status are listed.\n For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Name of the workflow type.\n This field is required.\n

\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n

\n Version of the workflow type.\n

\n " } }, "documentation": "\n

\n If specified, only executions of the type specified in the filter are returned.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "tagFilter": { "shape_name": "TagFilter", "type": "structure", "members": { "tag": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only executions that have the matching tag are listed.\n

\n closeStatusFilter, executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the results in reverse order. By default the results are returned in\n descending order of the start or the close time of the executions.\n

\n " } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionInfos", "type": "structure", "members": { "executionInfos": { "shape_name": "WorkflowExecutionInfoList", "type": "list", "members": { "shape_name": "WorkflowExecutionInfo", "type": "structure", "members": { "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution this information is about.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow execution.\n

\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the execution was started.\n

\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n

\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n

\n The current status of the execution.\n

\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n

\n If the execution status is closed then this specifies how the execution was closed:

\n \n " }, "parent": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n

\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n

\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n

\n Set to true if a cancellation is requested for this workflow execution.\n

\n " } }, "documentation": "\n

\n Contains information about a workflow execution.\n\n \n

\n " }, "documentation": "\n

\n The list of workflow information structures.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Contains a paginated list of information about workflow executions.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n ListClosedWorkflowExecutions Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:51:01 GMT\n X-Amz-Target: SimpleWorkflowService.ListClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=WY9jGbf5E3F9smGJHANhEXz9VL+1oGVgNL0/o7cBxQw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"closeTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 1084\n Content-Type: application/json\n x-amzn-RequestId: c28b4df4-3f23-11e1-9e8f-57bb03e21482\n\n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326590754.654,\n \"execution\":\n {\"runId\": \"c724e07a-b966-441f-a1c0-4831acbda1cd\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326587154.626,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326586831.628,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326582914.031,\n \"execution\":\n {\"runId\": \"1e536162-f1ea-48b0-85f3-aade88eef2f7\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326581114.02,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n \n " }, "ListDomains": { "name": "ListDomains", "input": { "shape_name": "ListDomainsInput", "type": "structure", "members": { "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextPageToken was returned, the result has\n more than one page. To get the next page of results, repeat the call with the returned token\n and all other arguments unchanged.\n

\n " }, "registrationStatus": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n Specifies the registration status of the domains to list.\n

\n ", "required": true }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name of the domains.\n

\n " } }, "documentation": null }, "output": { "shape_name": "DomainInfos", "type": "structure", "members": { "domainInfos": { "shape_name": "DomainInfoList", "type": "list", "members": { "shape_name": "DomainInfo", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain. This name is unique within the account.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The status of the domain:\n

\n \n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the domain provided through RegisterDomain.\n

\n " } }, "documentation": "\n

\n Contains general information about a domain.\n

\n " }, "documentation": "\n

\n A list of DomainInfo structures.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Contains a paginated collection of DomainInfo structures.\n

\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns the list of domains registered in the account.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n \n ListDomains Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:09:58 GMT\nX-Amz-Target: SimpleWorkflowService.ListDomains\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ZCprC72dUxF9ca3w/tbwKZ8lBQn0jaA4xOJqDF0uqMI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 86\nPragma: no-cache\nCache-Control: no-cache\n\n{\"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 568\nContent-Type: application/json\nx-amzn-RequestId: 67e874cc-3f26-11e1-9b11-7182192d0b57\n\n{\"domainInfos\":\n [\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"music\",\n \"name\": \"867530902\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Demo\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"DemoDomain\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Samples\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain2\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain3\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain4\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"zsxfvgsxcv\",\n \"status\": \"REGISTERED\"}\n ]\n}\n\n \n \n " }, "ListOpenWorkflowExecutions": { "name": "ListOpenWorkflowExecutions", "input": { "shape_name": "ListOpenWorkflowExecutionsInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain that contains the workflow executions to list.\n

\n ", "required": true }, "startTimeFilter": { "shape_name": "ExecutionTimeFilter", "type": "structure", "members": { "oldestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the oldest start or close date and time to return.\n

\n ", "required": true }, "latestDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n Specifies the latest start or close date and time to return.\n

\n " } }, "documentation": "\n

\n Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n

\n ", "required": true }, "typeFilter": { "shape_name": "WorkflowTypeFilter", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Name of the workflow type.\n This field is required.\n

\n ", "required": true }, "version": { "shape_name": "VersionOptional", "type": "string", "max_length": 64, "documentation": "\n

\n Version of the workflow type.\n

\n " } }, "documentation": "\n

\n If specified, only executions of the type specified in the filter are returned.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "tagFilter": { "shape_name": "TagFilter", "type": "structure", "members": { "tag": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only executions that have the matching tag are listed.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the results in reverse order. By default the results are returned in\n descending order of the start time of the executions.\n

\n " }, "executionFilter": { "shape_name": "WorkflowExecutionFilter", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId to pass of match the criteria of this filter.\n

\n ", "required": true } }, "documentation": "\n

\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n

\n executionFilter, typeFilter and tagFilter\n are mutually exclusive. You can specify at most one of these in a request.\n " } }, "documentation": null }, "output": { "shape_name": "WorkflowExecutionInfos", "type": "structure", "members": { "executionInfos": { "shape_name": "WorkflowExecutionInfoList", "type": "list", "members": { "shape_name": "WorkflowExecutionInfo", "type": "structure", "members": { "execution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution this information is about.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow execution.\n

\n ", "required": true }, "startTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the execution was started.\n

\n ", "required": true }, "closeTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n

\n " }, "executionStatus": { "shape_name": "ExecutionStatus", "enum": [ "OPEN", "CLOSED" ], "type": "string", "documentation": "\n

\n The current status of the execution.\n

\n ", "required": true }, "closeStatus": { "shape_name": "CloseStatus", "enum": [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ], "type": "string", "documentation": "\n

\n If the execution status is closed then this specifies how the execution was closed:

\n \n " }, "parent": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n

\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n

\n " }, "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n

\n Set to true if a cancellation is requested for this workflow execution.\n

\n " } }, "documentation": "\n

\n Contains information about a workflow execution.\n\n \n

\n " }, "documentation": "\n

\n The list of workflow information structures.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Contains a paginated list of information about workflow executions.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Returns a list of open workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n

\n \n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n ListOpenWorkflowExecutions \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:51:04 GMT\n X-Amz-Target: SimpleWorkflowService.ListOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=4kUhpZUp37PgpeOKHlWTsZi+Pq3Egw4mTkPNiEUgp28=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 151\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"music purchase\"}\n }\n \n \n HTTP/1.1 200 OK\n Content-Length: 313\n Content-Type: application/json\n x-amzn-RequestId: 9efeff4b-3f0a-11e1-9e8f-57bb03e21482\n\n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n \n " }, "ListWorkflowTypes": { "name": "ListWorkflowTypes", "input": { "shape_name": "ListWorkflowTypesInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the workflow types have been registered.\n

\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n If specified, lists the workflow type with this name.\n

\n " }, "registrationStatus": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n Specifies the registration status of the workflow types to list.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and all other arguments\n unchanged.\n

\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the name of the workflow types.\n

\n " } }, "documentation": null }, "output": { "shape_name": "WorkflowTypeInfos", "type": "structure", "members": { "typeInfos": { "shape_name": "WorkflowTypeInfoList", "type": "list", "members": { "shape_name": "WorkflowTypeInfo", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type this information is about.\n

\n ", "required": true }, "status": { "shape_name": "RegistrationStatus", "type": "string", "enum": [ "REGISTERED", "DEPRECATED" ], "documentation": "\n

\n The current status of the workflow type.\n

\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n The description of the type registered through RegisterWorkflowType.\n

\n " }, "creationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date when this type was registered.\n

\n ", "required": true }, "deprecationDate": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n

\n " } }, "documentation": "\n

\n Contains information about a workflow type.\n

\n " }, "documentation": "\n

\n The list of workflow type information.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n The token for the next page of type information. If set then the list consists of more than one page.\n You can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.\n

\n " } }, "documentation": "\n

\n Contains a paginated list of information structures about workflow types.\n

\n " }, "errors": [ { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " } ], "documentation": "\n

\n Returns information about workflow types in the specified domain. The results may be split into multiple\n pages that can be retrieved by making the call repeatedly.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n ListWorkflowTypes Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:25:43 GMT\n X-Amz-Target: SimpleWorkflowService.ListWorkflowTypes\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=uleWQSyVVf0+aG50IoBJG5h0hzxNFNT97Mkn/FSCQ+Q=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 110\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 174\n Content-Type: application/json\n x-amzn-RequestId: dcde6719-3fc7-11e1-9e8f-57bb03e21482\n\n {\"typeInfos\":\n [\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n \n \n \n " }, "PollForActivityTask": { "name": "PollForActivityTask", "input": { "shape_name": "PollForActivityTaskInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain that contains the task lists being polled.\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n Specifies the task list to poll for activity tasks.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the worker making the request, which is recorded in the\n ActivityTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

\n " } }, "documentation": null }, "output": { "shape_name": "ActivityTask", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique ID of the task.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskStarted event recorded in the history.\n

\n ", "required": true }, "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution that started this activity task.\n

\n ", "required": true }, "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of this activity task.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The inputs provided when the activity task was scheduled. The form of the input is\n user defined and should be meaningful to the activity implementation.\n

\n " } }, "documentation": "\n

\n Unit of work sent to an activity worker.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " } ], "documentation": "\n

\n Used by workers to get an ActivityTask from the specified activity taskList.\n This initiates a long poll, where the service holds the HTTP\n connection open and responds as soon as a task becomes available.\n The maximum time the service holds on to the request before responding is 60 seconds. If no task is\n available within 60 seconds, the poll will return an empty result.\n An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string.\n If a task is returned, the worker should use its type to identify and process it correctly.\n

\n \n Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n PollForActivityTask Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:53:52 GMT\n X-Amz-Target: SimpleWorkflowService.PollForActivityTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=dv0H1RPYucoIcRckspWO0f8xG120MWZRKmj3O5/A4rY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 108\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"mainTaskList\"},\n \"identity\": \"VerifyCreditCardWorker01\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 837\n Content-Type: application/json\n x-amzn-RequestId: b48fb6b5-3ff5-11e1-a23a-99d60383ae71\n\n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"startedEventId\": 11,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"workflowExecution\":\n {\"runId\": \"cfa2bd33-31b0-4b75-b131-255bb0d97b3f\",\n \"workflowId\": \"20110927-T-1\"}\n }\n \n \n \n " }, "PollForDecisionTask": { "name": "PollForDecisionTask", "input": { "shape_name": "PollForDecisionTaskInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the task lists to poll.\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n Specifies the task list to poll for decision tasks.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the decider making the request, which is recorded in the\n DecisionTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

\n " }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n If on a previous call to this method a NextPageToken was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n

\n The nextPageToken returned by this action cannot be used with\n GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again\n (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask\n with a nextPageToken will not return a new decision task..\n\n " }, "maximumPageSize": { "shape_name": "PageSize", "type": "integer", "min_length": 0, "max_length": 1000, "documentation": "\n

\n The maximum number of history events returned in each page. The default is 100, but the caller\n can override this value to a page size smaller than the default. You cannot specify a\n page size greater than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n

\n " }, "reverseOrder": { "shape_name": "ReverseOrder", "type": "boolean", "documentation": "\n

\n When set to true, returns the events in reverse order. By default the results are returned in ascending order\n of the eventTimestamp of the events.\n

\n " } }, "documentation": null }, "output": { "shape_name": "DecisionTask", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskStarted event recorded in the history.\n

\n ", "required": true }, "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution for which this decision task was created.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow execution for which this decision task was created.\n

\n ", "required": true }, "events": { "shape_name": "HistoryEventList", "type": "list", "members": { "shape_name": "HistoryEvent", "type": "structure", "members": { "eventTimestamp": { "shape_name": "Timestamp", "type": "timestamp", "documentation": "\n

\n The date and time when the event occurred.\n

\n ", "required": true }, "eventType": { "shape_name": "EventType", "type": "string", "enum": [ "WorkflowExecutionStarted", "WorkflowExecutionCancelRequested", "WorkflowExecutionCompleted", "CompleteWorkflowExecutionFailed", "WorkflowExecutionFailed", "FailWorkflowExecutionFailed", "WorkflowExecutionTimedOut", "WorkflowExecutionCanceled", "CancelWorkflowExecutionFailed", "WorkflowExecutionContinuedAsNew", "ContinueAsNewWorkflowExecutionFailed", "WorkflowExecutionTerminated", "DecisionTaskScheduled", "DecisionTaskStarted", "DecisionTaskCompleted", "DecisionTaskTimedOut", "ActivityTaskScheduled", "ScheduleActivityTaskFailed", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "ActivityTaskTimedOut", "ActivityTaskCanceled", "ActivityTaskCancelRequested", "RequestCancelActivityTaskFailed", "WorkflowExecutionSignaled", "MarkerRecorded", "RecordMarkerFailed", "TimerStarted", "StartTimerFailed", "TimerFired", "TimerCanceled", "CancelTimerFailed", "StartChildWorkflowExecutionInitiated", "StartChildWorkflowExecutionFailed", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed", "ChildWorkflowExecutionTimedOut", "ChildWorkflowExecutionCanceled", "ChildWorkflowExecutionTerminated", "SignalExternalWorkflowExecutionInitiated", "SignalExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionSignaled", "RequestCancelExternalWorkflowExecutionInitiated", "RequestCancelExternalWorkflowExecutionFailed", "ExternalWorkflowExecutionCancelRequested" ], "documentation": "\n

\n The type of the history event.\n

\n ", "required": true }, "eventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n

\n ", "required": true }, "workflowExecutionStartedEventAttributes": { "shape_name": "WorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the workflow execution (if any).\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration of decision tasks for this workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n\n The supported child policies are:\n

\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list for scheduling the decision tasks for this workflow execution.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type of this execution.\n

\n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n

\n " }, "continuedExecutionRunId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then\n it contains the runId of the previous workflow execution that was closed and continued as this execution.\n

\n " }, "parentWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n

\n " }, "parentInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCompletedEventAttributes": { "shape_name": "WorkflowExecutionCompletedEventAttributes", "type": "structure", "members": { "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result produced by the workflow execution upon successful completion.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "completeWorkflowExecutionFailedEventAttributes": { "shape_name": "CompleteWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "CompleteWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CompleteWorkflowExecution decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CompleteWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionFailedEventAttributes": { "shape_name": "WorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The descriptive reason provided for the failure (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "failWorkflowExecutionFailedEventAttributes": { "shape_name": "FailWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "FailWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the FailWorkflowExecution decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type FailWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionTimedOutEventAttributes": { "shape_name": "WorkflowExecutionTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of timeout that caused this event.\n

\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n

\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCanceledEventAttributes": { "shape_name": "WorkflowExecutionCanceledEventAttributes", "type": "structure", "members": { "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details for the cancellation (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "cancelWorkflowExecutionFailedEventAttributes": { "shape_name": "CancelWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "CancelWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CancelWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionContinuedAsNewEventAttributes": { "shape_name": "WorkflowExecutionContinuedAsNewEventAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the new workflow execution.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "newExecutionRunId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The runId of the new workflow execution.\n

\n ", "required": true }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The total duration allowed for the new workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a task list.\n

\n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration of decision tasks for the new workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

\n\n

The supported child policies are:

\n \n ", "required": true }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags associated with the new workflow execution.\n

\n " }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a workflow type.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type WorkflowExecutionContinuedAsNew then this member is set and\n provides detailed information about the event. It is not set for other event types.\n

\n " }, "continueAsNewWorkflowExecutionFailedEventAttributes": { "shape_name": "ContinueAsNewWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "cause": { "shape_name": "ContinueAsNewWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNHANDLED_DECISION", "WORKFLOW_TYPE_DEPRECATED", "WORKFLOW_TYPE_DOES_NOT_EXIST", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the ContinueAsNewWorkflowExecution decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ContinueAsNewWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionTerminatedEventAttributes": { "shape_name": "WorkflowExecutionTerminatedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "TerminateReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason provided for the termination (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details provided for the termination (if any).\n

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:

\n \n ", "required": true }, "cause": { "shape_name": "WorkflowExecutionTerminatedCause", "type": "string", "enum": [ "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED" ], "documentation": "\n

\n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionCancelRequestedEventAttributes": { "shape_name": "WorkflowExecutionCancelRequestedEventAttributes", "type": "structure", "members": { "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution for which the cancellation was requested.\n

\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " }, "cause": { "shape_name": "WorkflowExecutionCancelRequestedCause", "type": "string", "enum": [ "CHILD_POLICY_APPLIED" ], "documentation": "\n

\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionCancelRequested then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskScheduledEventAttributes": { "shape_name": "DecisionTaskScheduledEventAttributes", "type": "structure", "members": { "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list in which the decision task was scheduled.\n

\n ", "required": true }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " } }, "documentation": "\n

\n If the event is of type DecisionTaskScheduled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskStartedEventAttributes": { "shape_name": "DecisionTaskStartedEventAttributes", "type": "structure", "members": { "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskCompletedEventAttributes": { "shape_name": "DecisionTaskCompletedEventAttributes", "type": "structure", "members": { "executionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n User defined context for the workflow execution.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "decisionTaskTimedOutEventAttributes": { "shape_name": "DecisionTaskTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "DecisionTaskTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of timeout that expired before the decision task could be completed.\n

\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskScheduled event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the DecisionTaskStarted event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskScheduledEventAttributes": { "shape_name": "ActivityTaskScheduledEventAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the activity task.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique id of the activity task.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the activity task.\n

\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n

\n " }, "scheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time the activity task can wait to be assigned to a worker.\n

\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time for this activity task.\n

\n " }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum amount of time a worker may take to process the activity task.\n

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The task list in which the activity task has been scheduled.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "heartbeatTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum time before which the worker processing this task must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskScheduled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskStartedEventAttributes": { "shape_name": "ActivityTaskStartedEventAttributes", "type": "structure", "members": { "identity": { "shape_name": "Identity", "type": "string", "max_length": 256, "documentation": "\n

\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCompletedEventAttributes": { "shape_name": "ActivityTaskCompletedEventAttributes", "type": "structure", "members": { "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The results of the activity task (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskFailedEventAttributes": { "shape_name": "ActivityTaskFailedEventAttributes", "type": "structure", "members": { "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason provided for the failure (if any).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskTimedOutEventAttributes": { "shape_name": "ActivityTaskTimedOutEventAttributes", "type": "structure", "members": { "timeoutType": { "shape_name": "ActivityTaskTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT" ], "documentation": "\n

\n The type of the timeout that caused this event.\n

\n ", "required": true }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "details": { "shape_name": "LimitedData", "type": "string", "max_length": 2048, "documentation": "\n

\n Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCanceledEventAttributes": { "shape_name": "ActivityTaskCanceledEventAttributes", "type": "structure", "members": { "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the cancellation (if any).\n

\n " }, "scheduledEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the ActivityTaskScheduled event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ActivityTaskStarted event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "latestCancelRequestedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n If set, contains the Id of the last ActivityTaskCancelRequested event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n " } }, "documentation": "\n

\n If the event is of type ActivityTaskCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "activityTaskCancelRequestedEventAttributes": { "shape_name": "ActivityTaskCancelRequestedEventAttributes", "type": "structure", "members": { "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique ID of the task.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ActivityTaskcancelRequested then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "workflowExecutionSignaledEventAttributes": { "shape_name": "WorkflowExecutionSignaledEventAttributes", "type": "structure", "members": { "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n

\n " }, "externalWorkflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n

\n " }, "externalInitiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflow decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n

\n " } }, "documentation": "\n

\n If the event is of type WorkflowExecutionSignaled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "markerRecordedEventAttributes": { "shape_name": "MarkerRecordedEventAttributes", "type": "structure", "members": { "markerName": { "shape_name": "MarkerName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the marker.\n

\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the marker (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarker decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type MarkerRecorded then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "recordMarkerFailedEventAttributes": { "shape_name": "RecordMarkerFailedEventAttributes", "type": "structure", "members": { "markerName": { "shape_name": "MarkerName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

The marker's name.

\n ", "required": true }, "cause": { "shape_name": "RecordMarkerFailedCause", "type": "string", "enum": [ "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RecordMarkerFailed decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

\n ", "required": true } }, "documentation": "\n

\n If the event is of type DecisionTaskFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerStartedEventAttributes": { "shape_name": "TimerStartedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that was started.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The duration of time after which the timer will fire.\n

\n

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerFiredEventAttributes": { "shape_name": "TimerFiredEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that fired.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerFired then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "timerCanceledEventAttributes": { "shape_name": "TimerCanceledEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer that was canceled.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the TimerStarted event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type TimerCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "startChildWorkflowExecutionInitiatedEventAttributes": { "shape_name": "StartChildWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the child workflow execution.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n

\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The inputs provided to the child workflow execution (if any).\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list used for the decision tasks of the child workflow execution.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the TerminateWorkflowExecution action or due to an expired timeout.

\n

The supported child policies are:

\n\n \n ", "required": true }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration allowed for the decision tasks for this workflow execution.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags to associated with the child workflow execution.\n

\n " } }, "documentation": "\n

\n If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionStartedEventAttributes": { "shape_name": "ChildWorkflowExecutionStartedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was started.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionStarted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionCompletedEventAttributes": { "shape_name": "ChildWorkflowExecutionCompletedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was completed.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result of the child workflow execution (if any).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionFailedEventAttributes": { "shape_name": "ChildWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that failed.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n The reason for the failure (if provided).\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The details of the failure (if provided).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionFailed then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionTimedOutEventAttributes": { "shape_name": "ChildWorkflowExecutionTimedOutEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that timed out.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "timeoutType": { "shape_name": "WorkflowExecutionTimeoutType", "type": "string", "enum": [ "START_TO_CLOSE" ], "documentation": "\n

\n The type of the timeout that caused the child workflow execution to time out.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionCanceledEventAttributes": { "shape_name": "ChildWorkflowExecutionCanceledEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was canceled.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Details of the cancellation (if provided).\n

\n " }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "childWorkflowExecutionTerminatedEventAttributes": { "shape_name": "ChildWorkflowExecutionTerminatedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The child workflow execution that was terminated.\n

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "startedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The Id of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides\n detailed information about the event. It is not set for other event types.\n

\n " }, "signalExternalWorkflowExecutionInitiatedEventAttributes": { "shape_name": "SignalExternalWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution to send the signal to.\n

\n " }, "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Input provided to the signal (if any).\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n

\n " } }, "documentation": "\n

\n If the event is of type SignalExternalWorkflowExecutionInitiated then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "externalWorkflowExecutionSignaledEventAttributes": { "shape_name": "ExternalWorkflowExecutionSignaledEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution that the signal was delivered to.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ExternalWorkflowExecutionSignaled then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "signalExternalWorkflowExecutionFailedEventAttributes": { "shape_name": "SignalExternalWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution that the signal was being delivered to.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution that the signal was being delivered to.\n

\n " }, "cause": { "shape_name": "SignalExternalWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the SignalExternalWorkflowExecutionInitiated event corresponding to the\n SignalExternalWorkflowExecution decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in\n the SignalExternalWorkflowExecution decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

If the event is of type SignalExternalWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.

\n " }, "externalWorkflowExecutionCancelRequestedEventAttributes": { "shape_name": "ExternalWorkflowExecutionCancelRequestedEventAttributes", "type": "structure", "members": { "workflowExecution": { "shape_name": "WorkflowExecution", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution.\n

\n ", "required": true }, "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n A system generated unique identifier for the workflow execution.\n

\n ", "required": true } }, "documentation": "\n

\n The external workflow execution to which the cancellation request was delivered.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ExternalWorkflowExecutionCancelRequested then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelExternalWorkflowExecutionInitiatedEventAttributes": { "shape_name": "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution to be canceled.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution to be canceled.\n

\n " }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " } }, "documentation": "\n

\n If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelExternalWorkflowExecutionFailedEventAttributes": { "shape_name": "RequestCancelExternalWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow to which the cancel request was to be delivered.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution.\n

\n " }, "cause": { "shape_name": "RequestCancelExternalWorkflowExecutionFailedCause", "type": "string", "enum": [ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the\n RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

\n If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "scheduleActivityTaskFailedEventAttributes": { "shape_name": "ScheduleActivityTaskFailedEventAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The activity type provided in the ScheduleActivityTask decision that failed.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId provided in the ScheduleActivityTask decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "ScheduleActivityTaskFailedCause", "type": "string", "enum": [ "ACTIVITY_TYPE_DEPRECATED", "ACTIVITY_TYPE_DOES_NOT_EXIST", "ACTIVITY_ID_ALREADY_IN_USE", "OPEN_ACTIVITIES_LIMIT_EXCEEDED", "ACTIVITY_CREATION_RATE_EXCEEDED", "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type ScheduleActivityTaskFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "requestCancelActivityTaskFailedEventAttributes": { "shape_name": "RequestCancelActivityTaskFailedEventAttributes", "type": "structure", "members": { "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId provided in the RequestCancelActivityTask decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "RequestCancelActivityTaskFailedCause", "type": "string", "enum": [ "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the RequestCancelActivityTask decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.

\n ", "required": true } }, "documentation": "\n

\n If the event is of type RequestCancelActivityTaskFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "startTimerFailedEventAttributes": { "shape_name": "StartTimerFailedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The timerId provided in the StartTimer decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "StartTimerFailedCause", "type": "string", "enum": [ "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartTimer decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type StartTimerFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "cancelTimerFailedEventAttributes": { "shape_name": "CancelTimerFailedEventAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The timerId provided in the CancelTimer decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "CancelTimerFailedCause", "type": "string", "enum": [ "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n

\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the CancelTimer decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true } }, "documentation": "\n

\n If the event is of type CancelTimerFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " }, "startChildWorkflowExecutionFailedEventAttributes": { "shape_name": "StartChildWorkflowExecutionFailedEventAttributes", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The workflow type provided in the StartChildWorkflowExecution Decision that failed.\n

\n ", "required": true }, "cause": { "shape_name": "StartChildWorkflowExecutionFailedCause", "type": "string", "enum": [ "WORKFLOW_TYPE_DOES_NOT_EXIST", "WORKFLOW_TYPE_DEPRECATED", "OPEN_CHILDREN_LIMIT_EXCEEDED", "OPEN_WORKFLOWS_LIMIT_EXCEEDED", "CHILD_CREATION_RATE_EXCEEDED", "WORKFLOW_ALREADY_RUNNING", "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_TASK_LIST_UNDEFINED", "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", "DEFAULT_CHILD_POLICY_UNDEFINED", "OPERATION_NOT_PERMITTED" ], "documentation": "\n

The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.

\n\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the child workflow execution.\n

\n ", "required": true }, "initiatedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the StartChildWorkflowExecutionInitiated event corresponding to the\n StartChildWorkflowExecution Decision to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n

\n ", "required": true }, "decisionTaskCompletedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskCompleted event corresponding to the decision task that\n resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": null } }, "documentation": "\n

\n If the event is of type StartChildWorkflowExecutionFailed then this member\n is set and provides detailed information about the event. It is not set for other event types.\n

\n " } }, "documentation": "\n

Event within a workflow execution. A history event can be one of these types:

\n \n " }, "documentation": "\n

\n A paginated list of history events of the workflow execution. The decider uses this\n during the processing of the decision task.\n

\n ", "required": true }, "nextPageToken": { "shape_name": "PageToken", "type": "string", "max_length": 2048, "documentation": "\n

\n Returns a value if the results are paginated. To get the next page of results,\n repeat the request specifying this token and all other arguments unchanged.\n

\n " }, "previousStartedEventId": { "shape_name": "EventId", "type": "long", "documentation": "\n

\n The id of the DecisionTaskStarted event of the previous decision task of this workflow execution\n that was processed by the decider. This can be used to determine the events in the history new since the\n last decision task received by the decider.\n

\n " } }, "documentation": "\n

\n A structure that represents a decision task. Decision tasks are sent to\n deciders in order for them to make decisions.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " } ], "documentation": "\n

\n Used by deciders to get a DecisionTask from the specified decision taskList.\n A decision task may be returned for any open workflow execution that is\n using the specified task list. The task includes a paginated view of the history of the workflow execution.\n The decider should use the workflow type and the history to determine how to properly handle the task.\n

\n

\n This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available.\n If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned.\n An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.\n

\n \n Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).\n \n \n Because the number of workflow history events for a single workflow execution might be very large, the result\n returned might be split up across a number of pages.\n To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call.\n Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n\n \n\n PollForDecisionTask Example \n\n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:09:54 GMT\n X-Amz-Target: SimpleWorkflowService.PollForDecisionTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=R3CJ2HMLSVpc2p6eafeztZCZWcgza+h61gSUuWx15gw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 171\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"identity\": \"Decider01\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 1639\n Content-Type: application/json\n x-amzn-RequestId: 03db54cf-3f1e-11e1-b118-3bfa5e8e7fc3\n\n {\"events\":\n [\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326593394.566,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"eventId\": 1,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"WorkflowExecutionStarted\",\n \"workflowExecutionStartedEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"parentInitiatedEventId\": 0,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n ],\n \"previousStartedEventId\": 0,\n \"startedEventId\": 3,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAATZDvCYwk/hP/X1ZGdJhb+T6OWzcBx2DPhsIi5HF4aGQI4OXrDE7Ny3uM+aiAhGrmeNyVAa4yNIBQuoZuJA5G+BoaB0JuHFBOynHDTnm7ayNH43KhMkfdrDG4elfHSz3m/EtbLnFGueAr7+3NKDG6x4sTKg3cZpOtSguSx05yI1X3AtscS8ATcLB2Y3Aub1YonN/i/k67voca/GFsSiwSz3AAnJj1IPvrujgIj9KUvckwRPC5ET7d33XJcRp+gHYzZsBLVBaRmV3gEYAnp2ICslFn4YSjGy+dFXCNpOa4G1O8pczCbFUGbQ3+5wf0RSaa/xMq2pfdBKnuFp0wp8kw1k+5ZsbtDZeZn8g5GyKCLiLms/xD0OxugGGUe5ZlAoHEkTWGxZj/G32P7cMoCgrcACfFPdx1LNYYEre7YiGiyjGnfW2t5mW7VK9Np28vcXVbdpH4JNEB9OuB1xqL8N8ifPVtc72uxB1i9XEdq/8rkXasSEw4TubB2FwgqnuJstmfEhpOdb5HfhR6OwmnHuk9eszO/fUkGucTUXQP2hhB+Gz\",\n \"workflowExecution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n \n\n \n\n \n\n " }, "RecordActivityTaskHeartbeat": { "name": "RecordActivityTaskHeartbeat", "input": { "shape_name": "RecordActivityTaskHeartbeatInput", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n \n ", "required": true }, "details": { "shape_name": "LimitedData", "type": "string", "max_length": 2048, "documentation": "\n

\n If specified, contains details about the progress of the task.\n

\n " } }, "documentation": null }, "output": { "shape_name": "ActivityTaskStatus", "type": "structure", "members": { "cancelRequested": { "shape_name": "Canceled", "type": "boolean", "documentation": "\n

\n Set to true if cancellation of the task is requested.\n

\n ", "required": true } }, "documentation": "\n

\n Status information about an activity task.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Used by activity workers to report to the service that the ActivityTask represented by the specified\n taskToken is still making progress. The worker can also (optionally) specify details of the progress,\n for example percent complete, using the details parameter.\n\n This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task.\n If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag\n returned by the service is set to true.\n

\n

\n This action resets the taskHeartbeatTimeout clock.\n The taskHeartbeatTimeout is specified in RegisterActivityType.\n

\n

\n This action does not in itself create an event in the workflow execution history.\n However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event\n that contains the information from the last heartbeat generated by the activity worker.\n

\n \n The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless\n of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also\n specified in RegisterActivityType.\n \n \n This operation is only useful for long-lived activities to report liveliness of the task and to determine\n if a cancellation is being attempted.\n \n\n \n If the cancelRequested flag returns true, a cancellation is being\n attempted. If the worker can cancel the activity, it should respond with\n RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RecordActivityTaskHeartbeat Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:55:06 GMT\n X-Amz-Target: SimpleWorkflowService.RecordActivityTaskHeartbeat\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=DEA8rw5TqtpqCeTljl7eotZkuWTgmGZ1PWyDNZPehT0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 623\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"details\": \"starting task\"}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 25\n Content-Type: application/json\n x-amzn-RequestId: e08622cd-3ff5-11e1-9b11-7182192d0b57\n\n {\"cancelRequested\":false}\n \n \n \n " }, "RegisterActivityType": { "name": "RegisterActivityType", "input": { "shape_name": "RegisterActivityTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which this activity is to be registered.\n

\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the activity type within the domain.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the activity type.\n

\n \n The activity type consists of the name and version, the combination of which must be unique within the domain.\n \n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true, "cli_name": "activity-version" }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n A textual description of the activity type.\n

\n " }, "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskHeartbeatTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives\n an UnknownResource fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used\n if a task list is not provided when a task is scheduled through the ScheduleActivityTask Decision.\n

\n " }, "defaultTaskScheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultTaskScheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum duration for a task of this activity type.\n This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "TypeAlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Registers a new activity type along with its configuration settings in the specified domain.\n

\n\n \n A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration\n settings of the type after its registration, and it must be registered as a new version.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RegisterActivityType Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:14:06 GMT\n X-Amz-Target: SimpleWorkflowService.RegisterActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=F9cptqaGWa2H7LW3dpctF9J5svsB6FRZ4krghCRnml0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 343\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"name\": \"activityVerify\",\n \"version\": \"1.0\",\n \"description\": \"Verify the customer credit card\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskScheduleToCloseTimeout\": \"900\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: d68969c7-3f0d-11e1-9b11-7182192d0b57\n \n \n \n " }, "RegisterDomain": { "name": "RegisterDomain", "input": { "shape_name": "RegisterDomainInput", "type": "structure", "members": { "name": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n Name of the domain to register. The name must be unique.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

Textual description of the domain.

\n " }, "workflowExecutionRetentionPeriodInDays": { "shape_name": "DurationInDays", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

A duration (in days) for which the record (including the history) of workflow executions in this domain should\n be kept by the service. After the retention period, the workflow execution will not be available in the results of\n visibility calls.

\n

If you pass the value NONE then there is no expiration for workflow execution history (effectively\n an infinite retention period).

\n ", "required": true } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "DomainAlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned if the specified domain already exists. You will\n get this fault even if the existing domain is in deprecated status.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Registers a new domain.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n

\n\n \n RegisterDomain Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:42:12 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=tzjkF55lxAxPhzp/BRGFYQRQRq6CqrM254dTDE/EncI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 91\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530902\",\n \"description\": \"music\",\n \"workflowExecutionRetentionPeriodInDays\": \"60\"}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 4ec4ac3f-3e16-11e1-9b11-7182192d0b57\n\n\n \n\n \n\n " }, "RegisterWorkflowType": { "name": "RegisterWorkflowType", "input": { "shape_name": "RegisterWorkflowTypeInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which to register the workflow type.\n

\n ", "required": true }, "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n

\n \n The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered\n workflow types, use the ListWorkflowTypes action.\n \n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true, "cli_name": "workflow-version" }, "description": { "shape_name": "Description", "type": "string", "max_length": 1024, "documentation": "\n

\n Textual description of the workflow type.\n

\n " }, "defaultTaskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum duration of decision tasks for this workflow type. This\n default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the\n StartChildWorkflowExecution Decision.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " }, "defaultExecutionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the default maximum duration for executions of this workflow type. You can\n override this default when starting an execution through the StartWorkflowExecution Action or\n StartChildWorkflowExecution Decision.\n

\n\n

\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a\n one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.\n

\n\n " }, "defaultTaskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.\n This default is used only if a task list is not provided when starting the execution\n through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.\n

\n " }, "defaultChildPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or\n the StartChildWorkflowExecution Decision.\n The supported child policies are:

\n \n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "TypeAlreadyExistsFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " }, { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Registers a new workflow type and its configuration settings in the specified domain.\n

\n

\n The retention period for the workflow history is set by the RegisterDomain action.\n

\n \n If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings\n of a workflow type once it is registered and it must be registered as a new version.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n\n \n RegisterWorkflowType Example \n\n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:59:33 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterWorkflowType\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=p5FUOoV3QXAafb7aK5z79Ztu5v0w9NeEqLu0ei+P9FA=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 300\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\",\n \"description\": \"Handle customer orders\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultChildPolicy\": \"TERMINATE\"}\n\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: bb469e67-3e18-11e1-9914-a356b6ea8bdf\n\n\n \n \n" }, "RequestCancelWorkflowExecution": { "name": "RequestCancelWorkflowExecution", "input": { "shape_name": "RequestCancelWorkflowExecutionInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the workflow execution to cancel.\n

\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the workflow execution to cancel.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the workflow execution to cancel.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Records a WorkflowExecutionCancelRequested event in the currently running workflow execution\n identified by the given domain, workflowId, and runId. This logically requests the\n cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n

\n \n If the runId is not specified, the\n WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the\n specified workflowId in the domain.\n \n \n Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of\n TerminateWorkflowExecution when possible.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RequestCancelWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:49:06 GMT\n X-Amz-Target: SimpleWorkflowService.RequestCancelWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=xODwV3kbpJbWVa6bQiV2zQAw9euGI3uXI82urc+bVeo=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 106\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 6bd0627e-3ffd-11e1-9b11-7182192d0b57\n \n \n \n " }, "RespondActivityTaskCanceled": { "name": "RespondActivityTaskCanceled", "input": { "shape_name": "RespondActivityTaskCanceledInput", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n \n\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional information about the cancellation.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n was successfully canceled. Additional details can be optionally provided using the details argument.\n

\n

\n These details (if provided) appear in the ActivityTaskCanceled event added to\n the workflow history.\n

\n \n Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns\n true and if the activity can be safely undone or abandoned.\n \n\n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RespondActivityTaskCanceled Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:36:44 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCanceled\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=7ZMb0Np0OyXw6hrFSBFDAfBnSaEP1TH7cAG29DL5BUI=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 640\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQlFok8Ay875ki85gos/Okm9kWg1Jm6DbwiBZgxyCrW2OS+DQQtrCTMr+KH1ouxrCVOkTXPOUY/M4Ujfr1CrsMi6S0DMD8/N6yxzd34+PIIvRY8w9M5z89PbPQKjKHKbz2ocbTnHgRThaBO4ZmeadNyZWSeQyZXmsQFmFuHfaH9P2ibzrDS1dU+s/iw/R9RBrRWArsph/FIfWdRUJfu/FH9IFPSb3KYKMVaJAOyWhcR1KrRGywIGxPC7m9tQjapXqitoRYj42qgABydT4NVR5cLCkeYW0LKxUGVU46+gNvRaUfYzP31JVARQh5d0j7S/ERi10m6bamPJ3UcZfLFbM42mIINywmcTORMpQ/nPGLU1iECYrtnAV0YTlGZfGm+Vi6Gcgwyi4hEjg7TCBjc6WBw3JuAfFvUPU5cfvAoX7quUZRA7JUnYGObE0y9zYuTnCx6C1GL7Ks2MEA0coIiAl4JZx6qsGYfeKjIGntTsoCEe1zjp5gRqfeD74kfeZg0HmqA0xiFGZ40OHbImnF5YHsedYfLk6u09SAkQMD8iJhT8\",\n \"details\": \"customer canceled transaction\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: b1a001a6-3ffb-11e1-9b11-7182192d0b57\n \n \n \n " }, "RespondActivityTaskCompleted": { "name": "RespondActivityTaskCompleted", "input": { "shape_name": "RespondActivityTaskCompletedInput", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n \n\n ", "required": true }, "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result of the activity task. It is a free form string that is implementation specific.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n completed successfully with a result (if provided).\n The result appears in the ActivityTaskCompleted event in the workflow\n history.\n

\n\n \n If the requested task does not complete successfully, use RespondActivityTaskFailed instead.\n If the worker finds that the task is canceled through the canceled flag returned by\n RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.\n \n\n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RespondActivityTaskCompleted Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:56:15 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=M+ygHbMHSHJiVrsAQTW/BfkgHoNzLPnPD+dVywJiPXE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 638\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"result\": \"customer credit card verified\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 0976f0f4-3ff6-11e1-9a27-0760db01a4a8\n \n \n \n " }, "RespondActivityTaskFailed": { "name": "RespondActivityTaskFailed", "input": { "shape_name": "RespondActivityTaskFailedInput", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The taskToken of the ActivityTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n \n\n ", "required": true }, "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n Description of the error that may assist in diagnostics.\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional detailed information about the failure.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Used by workers to tell the service that the ActivityTask identified by the taskToken\n has failed with reason (if specified).\n The reason and details appear in the\n ActivityTaskFailed event added to the workflow history.\n

\n\n

\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, RespondActivityTaskCanceled,\n RespondActivityTaskFailed, or the task has\n timed out.\n

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RespondActivityTaskFailed Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:17:24 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskFailed\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JC+/uds/mFEq8qca2WFs5kfp2eAEONc70IqFgHErhpc=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 682\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAdG7j7YFEl9pfKdXRL3Cy3Q3c1Z8QwdOSX53bKiUV6MMGXvf3Lrinmmzj1HFFl5lcwHzEFxLbMaSZ/lMt/RFJPumHXAnUqlYjZLODhrBqsIzDQFKcbCFMq7y4jm0EFzsV2Suv8iu/obcZ/idU8qjd9uG/82zumG2xz1Z4IbOFwOTlpj2++5YVH4ftyycIcjlDw58r0O1vAo4PEondkqjyn+YxBxyZLy1z1fvMi0zeO8Lh16w96y6v+KdVc/ECoez1Og8sROaXG0l8ptW5YR733LIuUBK4sxWa12egF5i4e8AV8JloojOaq0jy4iFsIscRazOSQErjo15Guz89BK2XW911P3I+X7nJjH0wwW55XGCs0jezvsEC8M6D9Ob7CgWr6RrnK3g1AKemcby2XqgQRN52DMIYxzV+lMS/QBYKOqtkLoMY0NKeuRVwm9f1zCY00v6kxqK9m2zFvaxqlJ5/JVCWMNWEWJfQZVtC3GzMWmzeCt7Auq8A5/Caq/DKyOhTIhY/Go00iiDA6ecP8taTYiVzb8VR5xEiQ1uCxnECkwW\",\n \"reason\": \"could not verify customer credit card\",\n \"details\": \"card number invalid\"}\n \n\n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feadaedd-3ff8-11e1-9e8f-57bb03e21482\n \n \n \n " }, "RespondDecisionTaskCompleted": { "name": "RespondDecisionTaskCompleted", "input": { "shape_name": "RespondDecisionTaskCompletedInput", "type": "structure", "members": { "taskToken": { "shape_name": "TaskToken", "type": "string", "min_length": 1, "max_length": 1024, "documentation": "\n

\n The taskToken from the DecisionTask.\n

\n \n The taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.\n \n\n ", "required": true }, "decisions": { "shape_name": "DecisionList", "type": "list", "members": { "shape_name": "Decision", "type": "structure", "members": { "decisionType": { "shape_name": "DecisionType", "type": "string", "enum": [ "ScheduleActivityTask", "RequestCancelActivityTask", "CompleteWorkflowExecution", "FailWorkflowExecution", "CancelWorkflowExecution", "ContinueAsNewWorkflowExecution", "RecordMarker", "StartTimer", "CancelTimer", "SignalExternalWorkflowExecution", "RequestCancelExternalWorkflowExecution", "StartChildWorkflowExecution" ], "documentation": "\n

\n Specifies the type of the decision.\n

\n ", "required": true }, "scheduleActivityTaskDecisionAttributes": { "shape_name": "ScheduleActivityTaskDecisionAttributes", "type": "structure", "members": { "activityType": { "shape_name": "ActivityType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of this activity.\n The combination of activity type name and version must be unique within a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of this activity.\n The combination of activity type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the activity task to schedule.\n This field is required.\n

\n ", "required": true }, "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId of the activity task.\n This field is required.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n

\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the activity task.\n

\n " }, "scheduleToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The maximum duration for this activity task.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList\n registered with the activity type will be used.\n

\n A task list for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default task list was specified at registration time then a fault will be returned.\n\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n " }, "scheduleToStartTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This\n overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.\n\n " }, "startToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the maximum duration a worker may take to process this activity task. This\n overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "heartbeatTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the maximum time before which a worker processing a task of this type must report progress by\n calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored.\n This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n " } }, "documentation": "\n

\n Provides details of the ScheduleActivityTask decision. It is not set for other decision types.\n

\n " }, "requestCancelActivityTaskDecisionAttributes": { "shape_name": "RequestCancelActivityTaskDecisionAttributes", "type": "structure", "members": { "activityId": { "shape_name": "ActivityId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The activityId of the activity task to be canceled.\n

\n ", "required": true } }, "documentation": "\n

\n Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.\n

\n " }, "completeWorkflowExecutionDecisionAttributes": { "shape_name": "CompleteWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "result": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The result of the workflow execution. The form of the result is implementation defined.\n

\n " } }, "documentation": "\n

\n Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "failWorkflowExecutionDecisionAttributes": { "shape_name": "FailWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "reason": { "shape_name": "FailureReason", "type": "string", "max_length": 256, "documentation": "\n

\n A descriptive reason for the failure that may help in diagnostics.\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional details of the failure.\n

\n " } }, "documentation": "\n

\n Provides details of the FailWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "cancelWorkflowExecutionDecisionAttributes": { "shape_name": "CancelWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional details of the cancellation.\n

\n " } }, "documentation": "\n

\n Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "continueAsNewWorkflowExecutionDecisionAttributes": { "shape_name": "ContinueAsNewWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input provided to the new workflow execution.\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n If set, specifies the total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field.\n If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n Represents a task list.\n

\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n Specifies the maximum duration of decision tasks for the new workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:

\n\n \n A child policy for the new workflow execution must be specified either as a default registered for its workflow type\n or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n \n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags to associate with the new workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n or ListClosedWorkflowExecutions and specifying a TagFilter.\n

\n " }, "workflowTypeVersion": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": null } }, "documentation": "\n

\n Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "recordMarkerDecisionAttributes": { "shape_name": "RecordMarkerDecisionAttributes", "type": "structure", "members": { "markerName": { "shape_name": "MarkerName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the marker.\n This file is required.\n

\n ", "required": true }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional details of the marker.\n

\n " } }, "documentation": "\n

\n Provides details of the RecordMarker decision. It is not set for other decision types.\n

\n " }, "startTimerDecisionAttributes": { "shape_name": "StartTimerDecisionAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer.\n This field is required.

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " }, "startToFireTimeout": { "shape_name": "DurationInSeconds", "type": "string", "min_length": 1, "max_length": 8, "documentation": "\n

\n The duration to wait before firing the timer.\n This field is required.\n

\n

The duration is specified in seconds. The valid values are integers greater than or equal to 0.

\n ", "required": true } }, "documentation": "\n

\n Provides details of the StartTimer decision. It is not set for other decision types.\n

\n " }, "cancelTimerDecisionAttributes": { "shape_name": "CancelTimerDecisionAttributes", "type": "structure", "members": { "timerId": { "shape_name": "TimerId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The unique Id of the timer to cancel. This field is required.\n

\n ", "required": true } }, "documentation": "\n

\n Provides details of the CancelTimer decision. It is not set for other decision types.\n

\n " }, "signalExternalWorkflowExecutionDecisionAttributes": { "shape_name": "SignalExternalWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the workflow execution to be signaled.\n This field is required.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the workflow execution to be signaled.\n

\n " }, "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal.The target workflow execution will use the signal name and\n input to process the signal.\n This field is required.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional input to be provided with the signal.The target workflow execution will use the signal name and\n input to process the signal.\n

\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n

\n " } }, "documentation": "\n

\n Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "requestCancelExternalWorkflowExecutionDecisionAttributes": { "shape_name": "RequestCancelExternalWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the external workflow execution to cancel.\n This field is required.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the external workflow execution to cancel.\n

\n " }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n

\n " } }, "documentation": "\n

\n Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.\n

\n " }, "startChildWorkflowExecutionDecisionAttributes": { "shape_name": "StartChildWorkflowExecutionDecisionAttributes", "type": "structure", "members": { "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow execution to be started.\n This field is required.\n

\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the workflow execution.\n This field is required.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "control": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the child workflow execution.\n

\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input to be provided to the workflow execution.\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The name of the task list to be used for decision tasks of the child workflow execution.\n

\n A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.\n\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n

\n

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

\n A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:

\n \n A child policy for the workflow execution being started must be specified either as a default registered for its workflow type\n or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n \n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags to associate with the child workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions\n or ListClosedWorkflowExecutions and specifying a TagFilter.\n

\n " } }, "documentation": "\n

\n Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.\n

\n " } }, "documentation": "\n

\n Specifies a decision made by the decider. A decision can be one of these types:\n

\n \n\n

Access Control

\n

If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions\n returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps\n keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n

Decision Failure

\n

Decisions can fail for several reasons

\n \n

One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause.\n If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions.\n

\n\n \n\n

\n The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.\n

\n\n \n A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task:\n CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution\n and ContinueAsNewWorkflowExecution.\n An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal\n or activity event had been added to the history while the decision task was being performed by the decider.\n Unlike the above situations which are\n logic issues, this fault is always possible because of race conditions in a distributed system. The right\n action here is to call RespondDecisionTaskCompleted without any decisions. This would result in\n another decision task with these new events included in the history. The decider should handle the new events and\n may decide to close the workflow execution.\n \n\n

How to Code a Decision

\n

\n You code a decision by first setting the\n decision type field to one of the above decision values, and then set the corresponding attributes field\n shown below:\n

\n \n\n " }, "documentation": "\n

\n The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs\n for the Decision structure for details.\n

\n " }, "executionContext": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n User defined context to add to workflow execution.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Used by deciders to tell the service that the DecisionTask identified by the taskToken\n has successfully completed. The decisions argument specifies the list of decisions made while\n processing the task.\n

\n

\n A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is\n attached to the event in the workflow execution history.\n

\n\n

Access Control

\n

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the\n list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies\n to be as readable as possible, you can express permissions on decisions as if they were actual API\n calls, including applying conditions to some parameters. For more information,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n RespondDecisionTaskCompleted Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:31:06 GMT\n X-Amz-Target: SimpleWorkflowService.RespondDecisionTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=FL4ouCb8n6j5egcKOXoa+5Vctc8WmA91B2ekKnks2J8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 1184\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQLPoqDSLcx4ksNCEQZCyEBqpKhE+FgFSOvHd9zlCROacKYHh640MkANx2y9YM3CQnec0kEb1oRvB6DxKesTY3U/UQhvBqPY7E4BYE6hkDj/NmSbt9EwEJ/a+WD+oc2sDNfeVz2x+6wjb5vQdFKwBoQ6MDWLFbAhcgK+ymoRjoBHrPsrNLX3IA6sQaPmQRZQs3FRZonoVzP6uXMCZPnCZQULFjU1kTM8VHzH7ywqWKVmmdvnqyREOCT9VqmYbhLntJXsDj+scAvuNy17MCX9M9AJ7V/5qrLCeYdWA4FBQgY4Ew6IC+dge/UZdVMmpW/uB7nvSk6owQIhapPh5pEUwwY/yNnoVLTiPOz9KzZlANyw7uDchBRLvUJORFtpP9ZQIouNP8QOvFWm7Idc50ahwGEdTCiG+KDXV8kAzx7wKHs7l1TXYkC15x0h3XPH0MdLeEjipv98EpZaMIVtgGSdRjluOjNWEL2zowZByitleI5bdvxZdgalAXXKEnbYE6/rfLGReAJKdh2n0dmTMI+tK7uuxIWX6F4ocqSI1Xb2x5zZ\",\n \"decisions\":\n [\n {\"decisionType\": \"ScheduleActivityTask\",\n \"scheduleActivityTaskDecisionAttributes\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"activityId\": \"verification-27\",\n \"control\": \"digital music\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"heartbeatTimeout\": \"120\"}\n }\n ],\n \"executionContext\": \"Black Friday\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feef79b5-3fd0-11e1-9a27-0760db01a4a8\n \n \n \n " }, "SignalWorkflowExecution": { "name": "SignalWorkflowExecution", "input": { "shape_name": "SignalWorkflowExecutionInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain containing the workflow execution to signal.\n

\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the workflow execution to signal.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the workflow execution to signal.\n

\n " }, "signalName": { "shape_name": "SignalName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the signal. This name must be meaningful to the target workflow.\n

\n ", "required": true }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.\n

\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Records a WorkflowExecutionSignaled event in the workflow execution history and creates\n a decision task for the workflow execution\n identified by the given domain, workflowId and runId. The event is recorded with the\n specified user defined signalName and input (if provided).\n

\n \n If a runId is not specified, then the WorkflowExecutionSignaled\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n \n \n If the specified workflow execution is not open, this method fails\n with UnknownResource.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n \n \n SignalWorkflowExecution Example \n \n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:06:18 GMT\n X-Amz-Target: SimpleWorkflowService.SignalWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=lQpBZezK7JNQrXeWuJE+l7S0ZwjOEONCeRyImoyfX+E=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 162\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"signalName\": \"CancelOrder\",\n \"input\": \"order 3553\"}\n \n \n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: bf78ae15-3f0c-11e1-9914-a356b6ea8bdf\n \n \n \n " }, "StartWorkflowExecution": { "name": "StartWorkflowExecution", "input": { "shape_name": "StartWorkflowExecutionInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the domain in which the workflow execution is created.\n

\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The user defined identifier associated with the workflow execution. You can use this to\n associate a custom identifier with the workflow execution. You may specify the same\n identifier if a workflow execution is logically a restart of a previous execution.\n You cannot have two open workflow executions with the same workflowId at the same time.\n

\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n ", "required": true }, "workflowType": { "shape_name": "WorkflowType", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true }, "version": { "shape_name": "Version", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The version of the workflow type.\n This field is required.\n The combination of workflow type name and version must be unique with in a domain.\n

\n ", "required": true } }, "documentation": "\n

\n The type of the workflow to start.\n

\n ", "required": true }, "taskList": { "shape_name": "TaskList", "type": "structure", "members": { "name": { "shape_name": "Name", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The name of the task list.\n

\n ", "required": true } }, "documentation": "\n

\n The task list to use for the decision tasks generated for this workflow execution.\n This overrides the defaultTaskList specified when registering the workflow type.\n

\n A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.\n

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".

\n " }, "input": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting.\n This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.\n

\n " }, "executionStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n\n

\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n

\n\n

\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot\n specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.\n

\n\n \n An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered.\n If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.\n \n\n " }, "tagList": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "string", "min_length": 1, "max_length": 256, "documentation": null }, "max_length": 5, "documentation": "\n

\n The list of tags to associate with the workflow execution. You can specify a maximum\n of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or\n ListClosedWorkflowExecutions and specifying a TagFilter.\n

\n " }, "taskStartToCloseTimeout": { "shape_name": "DurationInSecondsOptional", "type": "string", "max_length": 8, "documentation": "\n

\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.\n

\n\n

\n The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.\n

\n\n A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated,\n by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.\n The supported child policies are:

\n\n \n A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.\n " } }, "documentation": null }, "output": { "shape_name": "Run", "type": "structure", "members": { "runId": { "shape_name": "RunId", "type": "string", "min_length": 1, "max_length": 64, "documentation": "\n

\n The runId of a workflow execution. This Id is generated by the service and can be used to uniquely identify\n the workflow execution within a domain.\n

\n " } }, "documentation": "\n

\n Specifies the runId of a workflow execution.\n

\n " }, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "TypeDeprecatedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the specified activity or workflow type was already deprecated.\n

\n " }, { "shape_name": "WorkflowExecutionAlreadyStartedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by StartWorkflowExecution when an open execution with the same\n workflowId is already running in the specified domain.\n

\n " }, { "shape_name": "LimitExceededFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " }, { "shape_name": "DefaultUndefinedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": null } }, "documentation": null } ], "documentation": "\n

\n Starts an execution of the workflow type in the specified domain using the provided workflowId\n and input data.\n

\n

This action returns the newly started workflow execution.

\n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n \n StartWorkflowExecution Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sat, 14 Jan 2012 22:45:13 GMT\nX-Amz-Target: SimpleWorkflowService.StartWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=aYxuqLX+TO91kPVg+jh+aA8PWxQazQRN2+SZUGdOgU0=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 417\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"},\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"executionStartToCloseTimeout\": \"1800\",\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskStartToCloseTimeout\": \"600\",\n \"childPolicy\": \"TERMINATE\"}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 48\nContent-Type: application/json\nx-amzn-RequestId: 6c25f6e6-3f01-11e1-9a27-0760db01a4a8\n\n{\"runId\":\"1e536162-f1ea-48b0-85f3-aade88eef2f7\"}\n\n \n \n " }, "TerminateWorkflowExecution": { "name": "TerminateWorkflowExecution", "input": { "shape_name": "TerminateWorkflowExecutionInput", "type": "structure", "members": { "domain": { "shape_name": "DomainName", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The domain of the workflow execution to terminate.\n

\n ", "required": true }, "workflowId": { "shape_name": "WorkflowId", "type": "string", "min_length": 1, "max_length": 256, "documentation": "\n

\n The workflowId of the workflow execution to terminate.\n

\n ", "required": true }, "runId": { "shape_name": "RunIdOptional", "type": "string", "max_length": 64, "documentation": "\n

\n The runId of the workflow execution to terminate.\n

\n " }, "reason": { "shape_name": "TerminateReason", "type": "string", "max_length": 256, "documentation": "\n

\n An optional descriptive reason for terminating the workflow execution.\n

\n " }, "details": { "shape_name": "Data", "type": "string", "max_length": 32768, "documentation": "\n

\n Optional details for terminating the workflow execution.\n

\n " }, "childPolicy": { "shape_name": "ChildPolicy", "type": "string", "enum": [ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ], "documentation": "\n

\n If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.\n This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.\n The supported child policies are:

\n \n A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.\n\n " } }, "documentation": null }, "output": null, "errors": [ { "shape_name": "UnknownResourceFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n

\n " }, { "shape_name": "OperationNotPermittedFault", "type": "structure", "members": { "message": { "shape_name": "ErrorMessage", "type": "string", "documentation": "\n

\n A description that may help with diagnosing the cause of the fault.\n

\n " } }, "documentation": "\n

Returned when the caller does not have sufficient permissions to invoke the action.

\n " } ], "documentation": "\n

\n Records a WorkflowExecutionTerminated event and forces closure of the\n workflow execution identified by the given domain, runId, and workflowId.\n The child policy, registered with the workflow type or specified when starting this execution,\n is applied to any open child workflow executions of this\n workflow execution.\n

\n \n If the identified workflow execution was in progress, it is terminated immediately.\n \n \n If a runId is not specified, then the WorkflowExecutionTerminated\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n \n \n You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while\n TerminateWorkflowExecution does not.\n \n\n

Access Control

\n

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

\n \n

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies,\n see Using IAM to Manage Access to Amazon SWF Workflows.

\n\n\n \n TerminateWorkflowExecution Example \n\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 04:56:34 GMT\nX-Amz-Target: SimpleWorkflowService.TerminateWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JHMRAjN6JGPawEuhiANHfiCil9KOGfDF/cuXYmuu9S4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 218\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\",\n \"reason\": \"transaction canceled\",\n \"details\": \"customer credit card declined\",\n \"childPolicy\": \"TERMINATE\"}\n\n\n\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 76d68a47-3ffe-11e1-b118-3bfa5e8e7fc3\n\n \n \n " } }, "metadata": { "regions": { "us-east-1": null, "ap-northeast-1": null, "sa-east-1": null, "ap-southeast-1": null, "ap-southeast-2": null, "us-west-2": null, "us-west-1": null, "eu-west-1": null, "us-gov-west-1": null, "cn-north-1": "https://swf.cn-north-1.amazonaws.com.cn" }, "protocols": [ "https" ] }, "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": { "general_socket_errors": { "applies_when": { "socket_errors": [ "GENERAL_CONNECTION_ERROR" ] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "limit_exceeded": { "applies_when": { "response": { "http_status_code": 509 } } }, "throttling": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } } } } } }botocore-0.29.0/botocore/endpoint.py0000644000175000017500000002630512254746564016743 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import logging import time import threading from botocore.vendored.requests.sessions import Session from botocore.vendored.requests.utils import get_environ_proxies import six import botocore.response import botocore.exceptions from botocore.auth import AUTH_TYPE_MAPS from botocore.exceptions import UnknownSignatureVersionError from botocore.awsrequest import AWSRequest from botocore.compat import urljoin, json, quote logger = logging.getLogger(__name__) class Endpoint(object): """ Represents an endpoint for a particular service in a specific region. Only an endpoint can make requests. :ivar service: The Service object that describes this endpoints service. :ivar host: The fully qualified endpoint hostname. :ivar session: The session object. """ def __init__(self, service, region_name, host, auth, proxies=None): self.service = service self.session = self.service.session self.region_name = region_name self.host = host self.verify = True self.auth = auth if proxies is None: proxies = {} self.proxies = proxies self.http_session = Session() self._lock = threading.Lock() def __repr__(self): return '%s(%s)' % (self.service.endpoint_prefix, self.host) def make_request(self, operation, params): logger.debug("Making request for %s (verify_ssl=%s) with params: %s", operation, self.verify, params) request = self._create_request_object(operation, params) prepared_request = self.prepare_request(request) return self._send_request(prepared_request, operation) def _create_request_object(self, operation, params): raise NotImplementedError('_create_request_object') def prepare_request(self, request): if self.auth is not None: with self._lock: # Parts of the auth signing code aren't thread safe (things # that manipulate .auth_path), so we're using a lock here to # prevent race conditions. event = self.session.create_event( 'before-auth', self.service.endpoint_prefix) self.session.emit(event, endpoint=self, request=request, auth=self.auth) self.auth.add_auth(request=request) prepared_request = request.prepare() return prepared_request def _send_request(self, request, operation): attempts = 1 response, exception = self._get_response(request, operation, attempts) while self._needs_retry(attempts, operation, response, exception): attempts += 1 # If there is a stream associated with the request, we need # to reset it before attempting to send the request again. # This will ensure that we resend the entire contents of the # body. request.reset_stream() response, exception = self._get_response(request, operation, attempts) return response def _get_response(self, request, operation, attempts): try: logger.debug("Sending http request: %s", request) http_response = self.http_session.send( request, verify=self.verify, stream=operation.is_streaming(), proxies=self.proxies) except Exception as e: return (None, e) # This returns the http_response and the parsed_data. return (botocore.response.get_response(self.session, operation, http_response), None) def _needs_retry(self, attempts, operation, response=None, caught_exception=None): event = self.session.create_event( 'needs-retry', self.service.endpoint_prefix, operation.name) handler_response = self.session.emit_first_non_none_response( event, response=response, endpoint=self, operation=operation, attempts=attempts, caught_exception=caught_exception) if handler_response is None: return False else: # Request needs to be retried, and we need to sleep # for the specified number of times. logger.debug("Response received to retry, sleeping for " "%s seconds", handler_response) time.sleep(handler_response) return True class QueryEndpoint(Endpoint): """ This class handles only AWS/Query style services. """ def _create_request_object(self, operation, params): params['Action'] = operation.name params['Version'] = self.service.api_version user_agent = self.session.user_agent() request = AWSRequest(method='POST', url=self.host, data=params, headers={'User-Agent': user_agent}) return request class JSONEndpoint(Endpoint): """ This class handles only AWS/JSON style services. """ ResponseContentTypes = ['application/x-amz-json-1.1', 'application/json'] def _create_request_object(self, operation, params): user_agent = self.session.user_agent() target = '%s.%s' % (self.service.target_prefix, operation.name) json_version = '1.0' if hasattr(self.service, 'json_version'): json_version = str(self.service.json_version) content_type = 'application/x-amz-json-%s' % json_version content_encoding = 'amz-1.0' data = json.dumps(params) request = AWSRequest(method='POST', url=self.host, data=data, headers={'User-Agent': user_agent, 'X-Amz-Target': target, 'Content-Type': content_type, 'Content-Encoding': content_encoding}) return request class RestEndpoint(Endpoint): def build_uri(self, operation, params): logger.debug('Building URI for rest endpoint.') uri = operation.http['uri'] if '?' in uri: path, query_params = uri.split('?') else: path = uri query_params = '' logger.debug('Templated URI path: %s', path) logger.debug('Templated URI query_params: %s', query_params) path_components = [] for pc in path.split('/'): if pc: pc = six.text_type(pc).format(**params['uri_params']) path_components.append(pc) path = quote('/'.join(path_components).encode('utf-8'), safe='/~') query_param_components = [] for qpc in query_params.split('&'): if qpc: if '=' in qpc: key_name, value_name = qpc.split('=') else: key_name = qpc value_name = None if value_name: value_name = value_name.strip('{}') if value_name in params['uri_params']: value = params['uri_params'][value_name] if isinstance(value, six.string_types): value = quote(value.encode('utf-8'), safe='/~') query_param_components.append('%s=%s' % ( key_name, value)) else: query_param_components.append(key_name) query_params = '&'.join(query_param_components) logger.debug('Rendered path: %s', path) logger.debug('Rendered query_params: %s', query_params) return path + '?' + query_params def _create_request_object(self, operation, params): user_agent = self.session.user_agent() params['headers']['User-Agent'] = user_agent uri = self.build_uri(operation, params) uri = urljoin(self.host, uri) payload = None if params['payload']: payload = params['payload'].getvalue() if payload is None: request = AWSRequest(method=operation.http['method'], url=uri, headers=params['headers']) else: request = AWSRequest(method=operation.http['method'], url=uri, headers=params['headers'], data=payload) return request def _get_proxies(url): # We could also support getting proxies from a config file, # but for now proxy support is taken from the environment. return get_environ_proxies(url) def get_endpoint(service, region_name, endpoint_url): cls = SERVICE_TO_ENDPOINT.get(service.type) if cls is None: raise botocore.exceptions.UnknownServiceStyle( service_style=service.type) service_name = getattr(service, 'signing_name', service.endpoint_prefix) auth = None if hasattr(service, 'signature_version'): auth = _get_auth(service.signature_version, credentials=service.session.get_credentials(), service_name=service_name, region_name=region_name, service_object=service) proxies = _get_proxies(endpoint_url) return cls(service, region_name, endpoint_url, auth=auth, proxies=proxies) def _get_auth(signature_version, credentials, service_name, region_name, service_object): cls = AUTH_TYPE_MAPS.get(signature_version) if cls is None: raise UnknownSignatureVersionError(signature_version=signature_version) else: kwargs = {'credentials': credentials} if cls.REQUIRES_REGION: if region_name is None: envvar_name = service_object.session.env_vars['region'][1] raise botocore.exceptions.NoRegionError(env_var=envvar_name) kwargs['region_name'] = region_name kwargs['service_name'] = service_name return cls(**kwargs) SERVICE_TO_ENDPOINT = { 'query': QueryEndpoint, 'json': JSONEndpoint, 'rest-xml': RestEndpoint, 'rest-json': RestEndpoint, } botocore-0.29.0/botocore/exceptions.py0000644000175000017500000001530112254746566017300 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # class BotoCoreError(Exception): """ The base exception class for BotoCore exceptions. :ivar msg: The descriptive message associated with the error. """ fmt = 'An unspecified error occured' def __init__(self, **kwargs): msg = self.fmt.format(**kwargs) Exception.__init__(self, msg) self.kwargs = kwargs class DataNotFoundError(BotoCoreError): """ The data associated with a particular path could not be loaded. :ivar path: The data path that the user attempted to load. """ fmt = 'Unable to load data for: {data_path}' class NoCredentialsError(BotoCoreError): """ No credentials could be found """ fmt = 'Unable to locate credentials' class NoRegionError(BotoCoreError): """ No region was specified :ivar env_var: The name of the environment variable to use to specify the default region. """ fmt = 'You must specify a region or set the {env_var} environment variable.' class UnknownSignatureVersionError(BotoCoreError): """ Requested Signature Version is not known. :ivar signature_version: The name of the requested signature version. """ fmt = 'Unknown Signature Version: {signature_version}.' class ServiceNotInRegionError(BotoCoreError): """ The service is not available in requested region. :ivar service_name: The name of the service. :ivar region_name: The name of the region. """ fmt = 'Service {service_name} not available in region {region_name}' class ProfileNotFound(BotoCoreError): """ The specified configuration profile was not found in the configuration file. :ivar profile: The name of the profile the user attempted to load. """ fmt = 'The config profile ({profile}) could not be found' class ConfigParseError(BotoCoreError): """ The configuration file could not be parsed. :ivar path: The path to the configuration file. """ fmt = 'Unable to parse config file: {path}' class ConfigNotFound(BotoCoreError): """ The specified configuration file could not be found. :ivar path: The path to the configuration file. """ fmt = 'The specified config file ({path}) could not be found.' class MissingParametersError(BotoCoreError): """ One or more required parameters were not supplied. :ivar object: The object that has missing parameters. This can be an operation or a parameter (in the case of inner params). The str() of this object will be used so it doesn't need to implement anything other than str(). :ivar missing: The names of the missing parameters. """ fmt = ('The following required parameters are missing for ' '{object_name}: {missing}') class ValidationError(BotoCoreError): """ An exception occurred validating parameters. Subclasses must accept a ``value`` and ``param`` argument in their ``__init__``. :ivar value: The value that was being validated. :ivar param: The parameter that failed validation. :ivar type_name: The name of the underlying type. """ fmt = ("Invalid value ('{value}') for param {param} " "of type {type_name} ") # These exceptions subclass from ValidationError so that code # can just 'except ValidationError' to catch any possibly validation # error. class UnknownKeyError(ValidationError): """ Unknown key in a struct paramster. :ivar value: The value that was being checked. :ivar param: The name of the parameter. :ivar choices: The valid choices the value can be. """ fmt = ("Unknown key '{value}' for param '{param}'. Must be one " "of: {choices}") class RangeError(ValidationError): """ A parameter value was out of the valid range. :ivar value: The value that was being checked. :ivar param: The parameter that failed validation. :ivar min_value: The specified minimum value. :ivar max_value: The specified maximum value. """ fmt = ('Value out of range for param {param}: ' '{min_value} <= {value} <= {max_value}') class UnknownParameterError(ValidationError): """ Unknown top level parameter. :ivar name: The name of the unknown parameter. :ivar operation: The name of the operation. :ivar choices: The valid choices the parameter name can be. """ fmt = ("Unknown parameter '{name}' for operation {operation}. Must be one " "of: {choices}") class UnknownServiceStyle(BotoCoreError): """ Unknown style of service invocation. :ivar service_style: The style requested. """ fmt = 'The service style ({service_style}) is not understood.' class PaginationError(BotoCoreError): fmt = 'Error during pagination: {message}' class EventNotFound(BotoCoreError): """ The specified event name is unknown to the system. :ivar event_name: The name of the event the user attempted to use. """ fmt = 'The event ({event_name}) is not known' class ChecksumError(BotoCoreError): """The expected checksum did not match the calculated checksum. """ fmt = ('Checksum {checksum_type} failed, expected checksum ' '{expected_checksum} did not match calculated checksum ' '{actual_checksum}.') class UnseekableStreamError(BotoCoreError): """Need to seek a stream, but stream does not support seeking. """ fmt = ('Need to rewind the stream {stream_object}, but stream ' 'is not seekable.') class WaiterError(BotoCoreError): """Waiter failed to reach desired state.""" fmt = 'Waiter {name} failed: {reason}' botocore-0.29.0/botocore/handlers.py0000644000175000017500000001706412254746566016727 0ustar takakitakaki# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # """Builtin event handlers. This module contains builtin handlers for events emitted by botocore. """ import base64 import hashlib import logging import re import six from botocore.compat import urlsplit, urlunsplit, unquote, json from botocore import retryhandler import botocore.auth logger = logging.getLogger(__name__) LABEL_RE = re.compile('[a-z0-9][a-z0-9\-]*[a-z0-9]') RESTRICTED_REGIONS = [ 'us-gov-west-1', 'fips-gov-west-1', ] def decode_console_output(event_name, shape, value, **kwargs): try: value = base64.b64decode(six.b(value)).decode('utf-8') except TypeError: logger.debug('Error decoding base64', exc_info=True) return value def decode_quoted_jsondoc(event_name, shape, value, **kwargs): try: value = json.loads(unquote(value)) except (ValueError, TypeError): logger.debug('Error loading quoted JSON', exc_info=True) return value def decode_jsondoc(event_name, shape, value, **kwargs): try: value = json.loads(value) except (ValueError, TypeError): logger.debug('error loading JSON', exc_info=True) return value def calculate_md5(event_name, params, **kwargs): if params['payload'] and not 'Content-MD5' in params['headers']: md5 = hashlib.md5() md5.update(six.b(params['payload'].getvalue())) value = base64.b64encode(md5.digest()).decode('utf-8') params['headers']['Content-MD5'] = value def check_dns_name(bucket_name): """ Check to see if the ``bucket_name`` complies with the restricted DNS naming conventions necessary to allow access via virtual-hosting style. Even though "." characters are perfectly valid in this DNS naming scheme, we are going to punt on any name containing a "." character because these will cause SSL cert validation problems if we try to use virtual-hosting style addressing. """ if '.' in bucket_name: return False n = len(bucket_name) if n < 3 or n > 63: # Wrong length return False if n == 1: if not bucket_name.isalnum(): return False match = LABEL_RE.match(bucket_name) if match is None or match.end() != len(bucket_name): return False return True def fix_s3_host(event_name, endpoint, request, auth, **kwargs): """ This handler looks at S3 requests just before they are signed. If there is a bucket name on the path (true for everything except ListAllBuckets) it checks to see if that bucket name conforms to the DNS naming conventions. If it does, it alters the request to use ``virtual hosting`` style addressing rather than ``path-style`` addressing. This allows us to avoid 301 redirects for all bucket names that can be CNAME'd. """ parts = urlsplit(request.url) auth.auth_path = parts.path path_parts = parts.path.split('/') if isinstance(auth, botocore.auth.S3SigV4Auth): return if len(path_parts) > 1: bucket_name = path_parts[1] logger.debug('Checking for DNS compatible bucket for: %s', request.url) if check_dns_name(bucket_name) and _allowed_region(endpoint.region_name): # If the operation is on a bucket, the auth_path must be # terminated with a '/' character. if len(path_parts) == 2: if auth.auth_path[-1] != '/': auth.auth_path += '/' path_parts.remove(bucket_name) host = bucket_name + '.' + endpoint.service.global_endpoint new_tuple = (parts.scheme, host, '/'.join(path_parts), parts.query, '') new_uri = urlunsplit(new_tuple) request.url = new_uri logger.debug('URI updated to: %s', new_uri) else: logger.debug('Not changing URI, bucket is not DNS compatible: %s', bucket_name) def _allowed_region(region_name): return region_name not in RESTRICTED_REGIONS def register_retries_for_service(service, **kwargs): if not hasattr(service, 'retry'): return logger.debug("Registering retry handlers for service: %s", service) config = service.retry session = service.session handler = retryhandler.create_retry_handler(config) unique_id = 'retry-config-%s' % service.endpoint_prefix session.register('needs-retry.%s' % service.endpoint_prefix, handler, unique_id=unique_id) _register_for_operations(config, session, service_name=service.endpoint_prefix) def _register_for_operations(config, session, service_name): # There's certainly a tradeoff for registering the retry config # for the operations when the service is created. In practice, # there aren't a whole lot of per operation retry configs so # this is ok for now. for key in config: if key == '__default__': continue handler = retryhandler.create_retry_handler(config, key) unique_id = 'retry-config-%s-%s' % (service_name, key) session.register('needs-retry.%s.%s' % (service_name, key), handler, unique_id=unique_id) def maybe_switch_to_s3sigv4(service, region_name, **kwargs): if region_name.startswith('cn-'): # This region only supports signature version 4 for # s3, so we need to change the service's signature version. service.signature_version = 's3v4' def maybe_switch_to_sigv4(service, region_name, **kwargs): if region_name.startswith('cn-'): # This region only supports signature version 4 for # s3, so we need to change the service's signature version. service.signature_version = 'v4' # This is a list of (event_name, handler). # When a Session is created, everything in this list will be # automatically registered with that Session. BUILTIN_HANDLERS = [ ('after-parsed.ec2.GetConsoleOutput.String.Output', decode_console_output), ('after-parsed.iam.*.policyDocumentType.*', decode_quoted_jsondoc), ('after-parsed.cloudformation.*.TemplateBody.TemplateBody', decode_jsondoc), ('before-call.s3.PutBucketTagging', calculate_md5), ('before-call.s3.PutBucketLifecycle', calculate_md5), ('before-call.s3.PutBucketCors', calculate_md5), ('before-call.s3.DeleteObjects', calculate_md5), ('before-auth.s3', fix_s3_host), ('service-created', register_retries_for_service), ('creating-endpoint.s3', maybe_switch_to_s3sigv4), ('creating-endpoint.ec2', maybe_switch_to_sigv4), ] botocore-0.29.0/botocore/hooks.py0000644000175000017500000002747612254746564016260 0ustar takakitakaki# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import inspect import six from collections import defaultdict, deque import logging logger = logging.getLogger(__name__) def first_non_none_response(responses, default=None): """Find first non None response in a list of tuples. This function can be used to find the first non None response from handlers connected to an event. This is useful if you are interested in the returned responses from event handlers. Example usage:: print(first_non_none_response([(func1, None), (func2, 'foo'), (func3, 'bar')])) # This will print 'foo' :type responses: list of tuples :param responses: The responses from the ``EventHooks.emit`` method. This is a list of tuples, and each tuple is (handler, handler_response). :param default: If no non-None responses are found, then this default value will be returned. :return: The first non-None response in the list of tuples. """ for response in responses: if response[1] is not None: return response[1] return default class BaseEventHooks(object): def emit(self, event_name, **kwargs): return [] def register(self, event_name, handler, unique_id=None): self._verify_is_callable(handler) self._verify_accept_kwargs(handler) self._register(event_name, handler, unique_id) def unregister(self, event_name, handler=None, unique_id=None): pass def _verify_is_callable(self, func): if not six.callable(func): raise ValueError("Event handler %s must be callable." % func) def _verify_accept_kwargs(self, func): """Verifies a callable accepts kwargs :type func: callable :param func: A callable object. :returns: True, if ``func`` accepts kwargs, otherwise False. """ try: argspec = inspect.getargspec(func) except TypeError: return False else: if argspec[2] is None: raise ValueError("Event handler %s must accept keyword " "arguments (**kwargs)" % func) class EventHooks(BaseEventHooks): def __init__(self): # event_name -> [handler, ...] self._handlers = defaultdict(list) def emit(self, event_name, **kwargs): """Call all handlers subscribed to an event. :type event_name: str :param event_name: The name of the event to emit. :type **kwargs: dict :param **kwargs: Arbitrary kwargs to pass through to the subscribed handlers. The ``event_name`` will be injected into the kwargs so it's not necesary to add this to **kwargs. :rtype: list of tuples :return: A list of ``(handler_func, handler_func_return_value)`` """ kwargs['event_name'] = event_name responses = [] for handler in self._handlers[event_name]: response = handler(**kwargs) responses.append((handler, response)) return responses def _register(self, event_name, handler, unique_id=None): self._handlers[event_name].append(handler) def unregister(self, event_name, handler, unique_id=None): try: self._handlers[event_name].remove(handler) except ValueError: pass class HierarchicalEmitter(BaseEventHooks): def __init__(self): # We keep a reference to the handlers for quick # read only access (we never modify self._handlers). # A cache of event name to handler list. self._lookup_cache = {} self._handlers = _PrefixTrie() # This is used to ensure that unique_id's are only # registered once. self._unique_id_cache = {} def emit(self, event_name, **kwargs): responses = [] # Invoke the event handlers from most specific # to least specific, each time stripping off a dot. handlers_to_call = self._lookup_cache.get(event_name) if handlers_to_call is None: handlers_to_call = self._handlers.prefix_search(event_name) self._lookup_cache[event_name] = handlers_to_call elif not handlers_to_call: # Short circuit and return an empty response is we have # no handlers to call. This is the common case where # for the majority of signals, nothing is listening. return [] kwargs['event_name'] = event_name responses = [] for handler in handlers_to_call: logger.debug('Event %s: calling handler %s', event_name, handler) response = handler(**kwargs) responses.append((handler, response)) return responses def _register(self, event_name, handler, unique_id=None): if unique_id is not None: if unique_id in self._unique_id_cache: # We've already registered a handler using this unique_id # so we don't need to register it again. return else: # Note that the trie knows nothing about the unique # id. We track uniqueness in this class via the # _unique_id_cache. self._handlers.append_item(event_name, handler) self._unique_id_cache[unique_id] = handler else: self._handlers.append_item(event_name, handler) # Super simple caching strategy for now, if we change the registrations # clear the cache. This has the opportunity for smarter invalidations. self._lookup_cache = {} def unregister(self, event_name, handler=None, unique_id=None): if unique_id is not None: try: handler = self._unique_id_cache.pop(unique_id) except KeyError: # There's no handler matching that unique_id so we have # nothing to unregister. return try: self._handlers.remove_item(event_name, handler) self._lookup_cache = {} except ValueError: pass class _PrefixTrie(object): """Specialized prefix trie that handles wildcards. The prefixes in this case are based on dot separated names so 'foo.bar.baz' is:: foo -> bar -> baz Wildcard support just means that having a key such as 'foo.bar.*.baz' will be matched with a call to ``get_items(key='foo.bar.ANYTHING.baz')``. You can think of this prefix trie as the equivalent as defaultdict(list), except that it can do prefix searches: foo.bar.baz -> A foo.bar -> B foo -> C Calling ``get_items('foo.bar.baz')`` will return [A + B + C], from most specific to least specific. """ def __init__(self): # Each dictionary can be though of as a node, where a node # has values associated with the node, and children is a link # to more nodes. So 'foo.bar' would have a 'foo' node with # a 'bar' node as a child of foo. # {'foo': {'children': {'bar': {...}}}}. self._root = {'chunk': None, 'children': {}, 'values': None} def append_item(self, key, value): """Add an item to a key. If a value is already associated with that key, the new value is appended to the list for the key. """ key_parts = key.split('.') current = self._root for part in key_parts: if part not in current['children']: new_child = {'chunk': part, 'values': None, 'children': {}} current['children'][part] = new_child current = new_child else: current = current['children'][part] if current['values'] is None: current['values'] = [value] else: current['values'].append(value) def prefix_search(self, key): """Collect all items that are prefixes of key. Prefix in this case are delineated by '.' characters so 'foo.bar.baz' is a 3 chunk sequence of 3 "prefixes" ( "foo", "bar", and "baz"). """ collected = deque() key_parts = key.split('.') current = self._root self._get_items(current, key_parts, collected, 0) return collected def _get_items(self, starting_node, key_parts, collected, starting_index): stack = [(starting_node, starting_index)] key_parts_len = len(key_parts) # Traverse down the nodes, where at each level we add the # next part from key_parts as well as the wildcard element '*'. # This means for each node we see we potentially add two more # elements to our stack. while stack: current_node, index = stack.pop() if current_node['values']: seq = reversed(current_node['values']) # We're using extendleft because we want # the values associated with the node furthest # from the root to come before nodes closer # to the root. collected.extendleft(seq) if not index == key_parts_len: children = current_node['children'] directs = children.get(key_parts[index]) wildcard = children.get('*') next_index = index + 1 if wildcard is not None: stack.append((wildcard, next_index)) if directs is not None: stack.append((directs, next_index)) def remove_item(self, key, value): """Remove an item associated with a key. If the value is not associated with the key a ``ValueError`` will be raised. If the key does not exist in the trie, a ``ValueError`` will be raised. """ key_parts = key.split('.') current = self._root self._remove_item(current, key_parts, value, index=0) def _remove_item(self, current_node, key_parts, value, index): if current_node is None: return elif index < len(key_parts): next_node = current_node['children'].get(key_parts[index]) if next_node is not None: self._remove_item(next_node, key_parts, value, index + 1) if index == len(key_parts) - 1: next_node['values'].remove(value) if not next_node['children'] and not next_node['values']: # Then this is a leaf node with no values so # we can just delete this link from the parent node. # This makes subsequent search faster in the case # where a key does not exist. del current_node['children'][key_parts[index]] else: raise ValueError( "key is not in trie: %s" % '.'.join(key_parts)) botocore-0.29.0/botocore/operation.py0000644000175000017500000002057712254746564017130 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import logging from botocore.parameters import get_parameter from botocore.exceptions import MissingParametersError from botocore.exceptions import UnknownParameterError from botocore.paginate import Paginator from botocore.payload import Payload, XMLPayload, JSONPayload from botocore import BotoCoreObject logger = logging.getLogger(__name__) class Operation(BotoCoreObject): _DEFAULT_PAGINATOR_CLS = Paginator def __init__(self, service, op_data, paginator_cls=None): self.input = {} self.output = {} BotoCoreObject.__init__(self, **op_data) self.service = service if self.service: self.session = self.service.session else: self.session = None self.type = 'operation' self._params = None if paginator_cls is None: paginator_cls = self._DEFAULT_PAGINATOR_CLS self._paginator_cls = paginator_cls def __repr__(self): return 'Operation:%s' % self.name def call(self, endpoint, **kwargs): logger.debug("%s called with kwargs: %s", self, kwargs) # It probably seems a little weird to be firing two different # events here. The reason is that the first event is fired # with the parameters exactly as supplied. The second event # is fired with the built parameters. Generally, it's easier # to manipulate the former but at times, like with ReST operations # that build an XML or JSON payload, you have to wait for # build_parameters to do it's job and the latter is necessary. event = self.session.create_event('before-parameter-build', self.service.endpoint_prefix, self.name) self.session.emit(event, operation=self, endpoint=endpoint, params=kwargs) params = self.build_parameters(**kwargs) event = self.session.create_event('before-call', self.service.endpoint_prefix, self.name) self.session.emit(event, operation=self, endpoint=endpoint, params=params) response = endpoint.make_request(self, params) event = self.session.create_event('after-call', self.service.endpoint_prefix, self.name) self.session.emit(event, operation=self, http_response=response[0], parsed=response[1]) return response @property def can_paginate(self): return hasattr(self, 'pagination') def paginate(self, endpoint, **kwargs): """Iterate over the responses of an operation. This will return an iterator with each element being a tuple of (``http_response``, ``parsed_response``). If the operation does not paginate, a ``TypeError`` will be raised. You can check if an operation can be paginated by using the ``can_paginate`` arg. """ if not self.can_paginate: raise TypeError("Operation cannot be paginated: %s" % self) paginator = self._paginator_cls(self) return paginator.paginate(endpoint, **kwargs) @property def params(self): if self._params is None: self._params = self._create_parameter_objects() return self._params def _create_parameter_objects(self): """ Build the list of Parameter objects for this operation. """ logger.debug("Creating parameter objects for: %s", self) params = [] if self.input and 'members' in self.input: for name, data in self.input['members'].items(): param = get_parameter(self, name, data) params.append(param) return params def _find_payload(self): """ Searches the parameters for an operation to find the payload parameter, if it exists. Returns that param or None. """ payload = None for param in self.params: if hasattr(param, 'payload') and param.payload: payload = param break return payload def _get_built_params(self): d = {} if self.service.type in ('rest-xml', 'rest-json'): d['uri_params'] = {} d['headers'] = {} if self.service.type == 'rest-xml': payload = self._find_payload() if payload and payload.type in ('blob', 'string'): # If we have a payload parameter which is a scalar # type (either string or blob) it means we need a # simple payload object rather than an XMLPayload. d['payload'] = Payload() else: # Otherwise, use an XMLPayload. Since Route53 # doesn't actually use the payload attribute, we # have to err on the safe side. namespace = self.service.xmlnamespace root_element_name = None if self.input and 'shape_name' in self.input: root_element_name = self.input['shape_name'] d['payload'] = XMLPayload(root_element_name=root_element_name, namespace=namespace) else: d['payload'] = JSONPayload() return d def build_parameters(self, **kwargs): """ Returns a dictionary containing the kwargs for the given operation formatted as required to pass to the service in a request. """ built_params = self._get_built_params() missing = [] self._check_for_unknown_params(kwargs) for param in self.params: if param.required: missing.append(param) if param.py_name in kwargs: if missing: missing.pop() param.build_parameter(self.service.type, kwargs[param.py_name], built_params) if missing: missing_str = ', '.join([p.py_name for p in missing]) raise MissingParametersError(missing=missing_str, object_name=self) return built_params def _check_for_unknown_params(self, kwargs): valid_names = [p.py_name for p in self.params] for key in kwargs: if key not in valid_names: raise UnknownParameterError(name=key, operation=self, choices=', '.join(valid_names)) def is_streaming(self): is_streaming = False if self.output: for member_name in self.output['members']: member_dict = self.output['members'][member_name] if member_dict['type'] == 'blob': if member_dict.get('payload', False): if member_dict.get('streaming', False): is_streaming = member_dict.get('xmlname', member_name) return is_streaming botocore-0.29.0/botocore/paginate.py0000644000175000017500000002750012254746564016711 0ustar takakitakaki# Copyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # from itertools import tee try: from itertools import zip_longest except ImportError: # Python2.x is izip_longest. from itertools import izip_longest as zip_longest try: zip except NameError: # Python2.x is izip. from itertools import izip as zip import jmespath from botocore.exceptions import PaginationError class Paginator(object): def __init__(self, operation): self._operation = operation self._pagination_cfg = operation.pagination self._output_token = self._get_output_tokens(self._pagination_cfg) self._input_token = self._get_input_tokens(self._pagination_cfg) self._more_results = self._get_more_results_token(self._pagination_cfg) self._result_keys = self._get_result_keys(self._pagination_cfg) @property def result_keys(self): return self._result_keys def _get_output_tokens(self, config): output = [] output_token = config['output_token'] if not isinstance(output_token, list): output_token = [output_token] for config in output_token: output.append(jmespath.compile(config)) return output def _get_input_tokens(self, config): input_token = self._pagination_cfg['py_input_token'] if not isinstance(input_token, list): input_token = [input_token] return input_token def _get_more_results_token(self, config): more_results = config.get('more_key') if more_results is not None: return jmespath.compile(more_results) def _get_result_keys(self, config): result_key = config.get('result_key') if result_key is not None: if not isinstance(result_key, list): result_key = [result_key] return result_key def paginate(self, endpoint, **kwargs): """Paginate responses to an operation. The responses to some operations are too large for a single response. When this happens, the service will indicate that there are more results in its response. This method handles the details of how to detect when this happens and how to retrieve more results. This method returns an iterator. Each element in the iterator is the result of an ``Operation.call`` call, so each element is a tuple of (``http_response``, ``parsed_result``). """ page_params = self._extract_paging_params(kwargs) return PageIterator(self._operation, self._input_token, self._output_token, self._more_results, self._result_keys, page_params['max_items'], page_params['starting_token'], endpoint, kwargs) def _extract_paging_params(self, kwargs): return { 'max_items': kwargs.pop('max_items', None), 'starting_token': kwargs.pop('starting_token', None), } class PageIterator(object): def __init__(self, operation, input_token, output_token, more_results, result_keys, max_items, starting_token, endpoint, op_kwargs): self._operation = operation self._input_token = input_token self._output_token = output_token self._more_results = more_results self._result_keys = result_keys self._max_items = max_items self._starting_token = starting_token self._endpoint = endpoint self._op_kwargs = op_kwargs self._resume_token = None @property def result_keys(self): return self._result_keys @property def resume_token(self): """Token to specify to resume pagination.""" return self._resume_token @resume_token.setter def resume_token(self, value): if isinstance(value, list): self._resume_token = '___'.join([str(v) for v in value]) def __iter__(self): current_kwargs = self._op_kwargs endpoint = self._endpoint previous_next_token = None next_token = [None for _ in range(len(self._input_token))] # The number of items from result_key we've seen so far. total_items = 0 first_request = True primary_result_key = self.result_keys[0] starting_truncation = 0 self._inject_starting_token(current_kwargs) while True: http_response, parsed = self._operation.call(endpoint, **current_kwargs) if first_request: # The first request is handled differently. We could # possibly have a resume/starting token that tells us where # to index into the retrieved page. if self._starting_token is not None: starting_truncation = self._handle_first_request( parsed, primary_result_key, starting_truncation) first_request = False num_current_response = len(parsed.get(primary_result_key, [])) truncate_amount = 0 if self._max_items is not None: truncate_amount = (total_items + num_current_response) \ - self._max_items if truncate_amount > 0: self._truncate_response(parsed, primary_result_key, truncate_amount, starting_truncation, next_token) yield http_response, parsed break else: yield http_response, parsed total_items += num_current_response next_token = self._get_next_token(parsed) if all(t is None for t in next_token): break if self._max_items is not None and \ total_items == self._max_items: # We're on a page boundary so we can set the current # next token to be the resume token. self.resume_token = next_token break if previous_next_token is not None and \ previous_next_token == next_token: message = ("The same next token was received " "twice: %s" % next_token) raise PaginationError(message=message) self._inject_token_into_kwargs(current_kwargs, next_token) previous_next_token = next_token def _inject_starting_token(self, op_kwargs): # If the user has specified a starting token we need to # inject that into the operation's kwargs. if self._starting_token is not None: # Don't need to do anything special if there is no starting # token specified. next_token = self._parse_starting_token()[0] self._inject_token_into_kwargs(op_kwargs, next_token) def _inject_token_into_kwargs(self, op_kwargs, next_token): for name, token in zip(self._input_token, next_token): if token is None or token == 'None': continue op_kwargs[name] = token def _handle_first_request(self, parsed, primary_result_key, starting_truncation): # First we need to slice into the array and only return # the truncated amount. starting_truncation = self._parse_starting_token()[1] parsed[primary_result_key] = parsed[ primary_result_key][starting_truncation:] # We also need to truncate any secondary result keys # because they were not truncated in the previous last # response. for token in self.result_keys: if token == primary_result_key: continue parsed[token] = [] return starting_truncation def _truncate_response(self, parsed, primary_result_key, truncate_amount, starting_truncation, next_token): original = parsed.get(primary_result_key, []) amount_to_keep = len(original) - truncate_amount truncated = original[:amount_to_keep] parsed[primary_result_key] = truncated # The issue here is that even though we know how much we've truncated # we need to account for this globally including any starting # left truncation. For example: # Raw response: [0,1,2,3] # Starting index: 1 # Max items: 1 # Starting left truncation: [1, 2, 3] # End right truncation for max items: [1] # However, even though we only kept 1, this is post # left truncation so the next starting index should be 2, not 1 # (left_truncation + amount_to_keep). next_token.append(str(amount_to_keep + starting_truncation)) self.resume_token = next_token def _get_next_token(self, parsed): if self._more_results is not None: if not self._more_results.search(parsed): return [None] next_tokens = [] for token in self._output_token: next_tokens.append(token.search(parsed)) return next_tokens def result_key_iters(self): teed_results = tee(self, len(self.result_keys)) return [ResultKeyIterator(i, result_key) for i, result_key in zip(teed_results, self.result_keys)] def build_full_result(self): iterators = self.result_key_iters() response = {} key_names = [i.result_key for i in iterators] for key in key_names: response[key] = [] for vals in zip_longest(*iterators): for k, val in zip(key_names, vals): if val is not None: response[k].append(val) if self.resume_token is not None: response['NextToken'] = self.resume_token return response def _parse_starting_token(self): if self._starting_token is None: return None parts = self._starting_token.split('___') next_token = [] index = 0 if len(parts) == len(self._input_token) + 1: try: index = int(parts.pop()) except ValueError: raise ValueError("Bad starting token: %s" % self._starting_token) for part in parts: if part == 'None': next_token.append(None) else: next_token.append(part) return next_token, index class ResultKeyIterator(object): """Iterates over the results of paginated responses.""" def __init__(self, pages_iterator, result_key): self._pages_iterator = pages_iterator self.result_key = result_key def __iter__(self): for _, page in self._pages_iterator: for result in page.get(self.result_key, []): yield result botocore-0.29.0/botocore/parameters.py0000644000175000017500000005217712254746564017274 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import logging import base64 import datetime import decimal import six import dateutil.parser from botocore import BotoCoreObject from botocore.exceptions import ValidationError, RangeError, UnknownKeyError from botocore.exceptions import MissingParametersError logger = logging.getLogger(__name__) class Parameter(BotoCoreObject): def __init__(self, operation, **kwargs): self.operation = operation self.xmlname = None self.required = False self.flattened = False self.allow_file = False self.min = None self.max = None self.payload = False self.streaming = False self.example_fn = None BotoCoreObject.__init__(self, **kwargs) self.cli_name = '--' + self.cli_name self._handle_subtypes() def _handle_subtypes(self): # Subclasses can implement this method to handle # any members they might have (useful for complex types). pass def validate(self, value): """Validate the value. If a parameter decides the value is not a valid value then they can raise a ``ValidationError``. """ pass def get_label(self): if self.xmlname: label = self.xmlname else: label = self.name return label def store_value_query(self, value, built_params, label): if label: label = label.format(label=self.get_label()) else: label = self.get_label() built_params[label] = str(value) def build_parameter_query(self, value, built_params, label=''): value = self.validate(value) self.store_value_query(value, built_params, label) def store_value_json(self, value, built_params, label): if isinstance(built_params, list): built_params.append(value) else: label = self.get_label() built_params[label] = value def build_parameter_json(self, value, built_params, label=''): value = self.validate(value) self.store_value_json(value, built_params, value) def build_parameter_rest(self, style, value, built_params, label=''): if hasattr(self, 'location'): if self.location == 'uri': built_params['uri_params'][self.name] = value elif self.location == 'header': if hasattr(self, 'location_name'): key = self.location_name else: key = self.name built_params['headers'][key] = value elif style == 'rest-json' or style == 'rest-xml': payload = built_params.get('payload') if payload is not None: payload.add_param(self, value, label) def build_parameter(self, style, value, built_params, label=''): self.validate(value) if style == 'query': self.build_parameter_query(value, built_params, label) elif style == 'json': self.build_parameter_json(value, built_params, label) elif style in ('rest-xml', 'rest-json'): self.build_parameter_rest(style, value, built_params, label) def to_xml(self, value, label=None): if not label: label = self.name return '<%s>%s' % (label, value, label) class IntegerParameter(Parameter): def validate(self, value): if not isinstance(value, six.integer_types): raise ValidationError(value=str(value), type_name='integer', param=self) if self.min: if value < self.min: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) if self.max: if value > self.max: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) return value class FloatParameter(Parameter): def validate(self, value): original_value = value # So isinstance(True, int) -> True. # For a float parameter we should not allow a bool. if isinstance(value, bool): raise ValidationError(value=str(value), type_name='float', param=self) elif not isinstance(value, float): # If the value is a float, that's good enough for a float # param. Also you can't go directly from a float -> Decimal # in python2.6. # Otherwise the value has to look like a decimal, # so we just need to validate that it converts to a # decimal without issue and then run it through the min # max range validations. try: # We don't want to type convert here, but we need # to convert it to something we can use < and > against. value = decimal.Decimal(value) except (decimal.InvalidOperation, TypeError): raise ValidationError(value=str(value), type_name='float', param=self) if self.min: if value < self.min: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) if self.max: if value > self.max: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) return original_value class DoubleParameter(Parameter): def validate(self, value): if not isinstance(value, float): raise ValidationError(value=str(value), type_name='double', param=self) if self.min: if value < self.min: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) if self.max: if value > self.max: raise RangeError(value=value, param=self, min_value=self.min, max_value=self.max) return value class BooleanParameter(Parameter): def validate(self, value): try: if not isinstance(value, bool): if isinstance(value, six.string_types): if value.lower() == 'true': value = True elif value.lower() == 'false': value = False else: raise ValueError return value except ValueError: raise ValidationError(value=str(value), type_name='boolean', param=self) def _getstring(self, value): if value: value = 'true' else: value = 'false' return value def build_parameter_query(self, value, built_params, label=''): value = self.validate(value) value = self._getstring(value) self.store_value_query(value, built_params, label) @property def false_name(self): false_name = '' if self.required: false_name = '--no-' + self.cli_name[2:] return false_name def to_xml(self, value, label=None): if not label: label = self.name value = self._getstring(value) return '<%s>%s' % (label, value, label) class TimestampParameter(Parameter): Epoch = datetime.datetime(1970, 1, 1) def totalseconds(self, td): value = td.microseconds + (td.seconds + td.days * 24 * 3600) return value * 10**6 / 10**6 def validate(self, value): try: return dateutil.parser.parse(value) except: pass try: # Might be specified as an epoch time return datetime.datetime.utcfromtimestamp(value) except: pass raise ValidationError(value=str(value), type_name='timestamp', param=self) def get_time_value(self, value): if self.operation.service.timestamp_format == 'unixTimestamp': delta = value - self.Epoch value = int(self.totalseconds(delta)) else: value = value.isoformat() return value def build_parameter_query(self, value, built_params, label=''): value = self.validate(value) self.store_value_query(self.get_time_value(value), built_params, label) def build_parameter_json(self, value, built_params, label=''): value = self.validate(value) self.store_value_json(self.get_time_value(value), built_params, value) class StringParameter(Parameter): def validate(self, value): if not isinstance(value, six.string_types): raise ValidationError(value=str(value), type_name='string', param=self) if self.min: if len(value) < self.min: raise RangeError(value=len(value), param=self, min_value=self.min, max_value=self.max) if self.max: if len(value) > self.max: raise RangeError(value=len(value), param=self, min_value=self.min, max_value=self.max) return value class BlobParameter(Parameter): def validate(self, value): allowed_types = six.string_types + (bytes, bytearray,) if self.payload and self.streaming: # Streaming blobs should be file-like objects or be strings. if not hasattr(value, 'read') and not isinstance(value, allowed_types): raise ValidationError(value=str(value), type_name='blob', param=self) else: if not isinstance(value, allowed_types): raise ValidationError(value=str(value), type_name='string', param=self) if not hasattr(self, 'payload') or self.payload is False: # Blobs that are not in the payload should be base64-encoded value = base64.b64encode(six.b(value)).decode('utf-8') return value class ListParameter(Parameter): def validate(self, value): if not isinstance(value, (list, tuple)): raise ValidationError(value=value, type_name='list', param=self) for item in value: try: self.members.validate(item) except ValidationError as e: # ValidationError must provide a value # argument so we can safely access that key. raise ValidationError(value=e.kwargs['value'], param='element of %s' % self, type_name='list') return value def _handle_subtypes(self): if self.members: self.members = get_parameter(self.operation, None, self.members) def build_parameter_query(self, value, built_params, label=''): logger.debug("Building parameter for query service, name: %r, " "label: %r", self.get_label(), label) value = self.validate(value) # If this is not a flattened list, find the label for member # items in the list. member_type = self.members if self.flattened: if member_type.xmlname: if label: label = label.format(label=member_type.xmlname) else: label = member_type.xmlname else: if label: label = label.format(label=self.get_label()) else: label = self.get_label() else: if label: label = label.format(label=self.get_label()) else: label = self.get_label() label = '%s.%s' % (label, 'member') if len(value) == 0 and self.required: # If the parameter is required and an empty list is # provided as a value, we should insert a parameter # into the dictionary with the base name of the # parameter and a value of the empty string. See # ELB SetLoadBalancerPoliciesForBackendServer for example. built_params[label.split('.')[0]] = '' else: for i, v in enumerate(value, 1): member_type.build_parameter_query(v, built_params, '%s.%d' % (label, i)) def build_parameter_json(self, value, built_params, label=''): value = self.validate(value) label = self.get_label() built_params[label] = [] for v in value: self.members.build_parameter_json(v, built_params[label], None) def to_xml(self, value, label=None): inner_xml = '' for item in value: xmlname = self.xmlname if not xmlname: xmlname = self.members.xmlname inner_xml += self.members.to_xml(item, xmlname) if self.flattened: return inner_xml else: if not label: label = self.xmlname return '<%s>' % label + inner_xml + '' % label class MapParameter(Parameter): def validate(self, value): if not isinstance(value, dict): raise ValidationError(value=str(value), type_name='map', param=self) def _handle_subtypes(self): if self.members: self.members = get_parameter(self.operation, None, self.members) if self.keys: self.keys = get_parameter(self.operation, None, self.keys) def build_parameter_query(self, value, built_params, label=''): label = self.get_label() if not self.flattened: label = '%s.entry' % label key_type = self.keys member_type = self.members for i, v in enumerate(value, 1): key_name = key_type.xmlname if not key_name: key_name = 'key' built_params['%s.%d.%s' % (label, i, key_name)] = v member_name = member_type.xmlname if not member_name: member_name = 'value' member_type.build_parameter_query( value[v], built_params, '%s.%d.%s' % (label, i, member_name)) def build_parameter_json(self, value, built_params, label=''): label = self.get_label() new_value = {} if isinstance(built_params, list): built_params.append(new_value) else: built_params[label] = new_value for key in value: new_value[key] = value[key] class StructParameter(Parameter): def validate(self, value): if not isinstance(value, dict): raise ValidationError(value=str(value), type_name='structure', param=self) self._validate_known_keys(value) self._validate_required_keys(value) for member in self.members: sub_value = value.get(member.name) if sub_value is not None: member.validate(sub_value) def _validate_known_keys(self, value): valid_keys = [p.name for p in self.members] for key in value: if key not in valid_keys: raise UnknownKeyError( value=key, choices=', '.join(valid_keys), param=self.name) def _validate_required_keys(self, value): # There are some inner params that are marked as required # even though the parent param is not marked required. # It would be a good enhancement to also validate those # params. missing = [] for required in [p.name for p in self.members if p.required]: if required not in value: missing.append(required) if missing: raise MissingParametersError(object_name=self, missing=', '.join(missing)) def _handle_subtypes(self): if self.members: l = [] for name, data in self.members.items(): l.append(get_parameter(self.operation, name, data)) self.members = l def build_parameter_query(self, value, built_params, label=''): if label: label = label.format(label=self.get_label()) else: label = self.get_label() label = '%s.{label}' % label for member in self.members: if member.required and member.name not in value: msg = 'Expected: %s, Got: %s' % (member.name, value.keys()) raise ValueError(msg) if member.name in value: member.build_parameter_query(value[member.name], built_params, label) def build_parameter_json(self, value, built_params, label=''): label = self.get_label() new_value = {} if isinstance(built_params, list): built_params.append(new_value) else: built_params[label] = new_value for member in self.members: if member.required and member.name not in value: msg = 'Expected: %s, Got: %s' % (member.name, value.keys()) raise ValueError(msg) if member.name in value: member_label = member.get_label() member.build_parameter_json(value[member.name], new_value, member_label) def store_value_json(self, value, built_params, label): label = self.get_label() built_params[label] = {} for member in self.members: if member.name in value: member.store_value_json(value[member.name], built_params[label], member.name) def to_xml(self, value, label=None): if not label: label = self.get_label() xml = '<%s' % label if hasattr(self, 'xmlnamespace'): xml += ' xmlns:%s="%s" ' % (self.xmlnamespace['prefix'], self.xmlnamespace['uri']) # Now we need to look for members that have an # xmlattribute attribute with a value of True. # The value of these attributes belongs in the xmlattribute # not in the body of the element. for member in self.members: if hasattr(member, 'xmlattribute'): xml += '%s="%s"' % (member.xmlname, value[member.name]) xml += '>' for member in self.members: if member.name in value and not hasattr(member, 'xmlattribute'): xml += member.to_xml(value[member.name], member.name) xml += '' % label return xml type_map = { 'structure': StructParameter, 'map': MapParameter, 'timestamp': TimestampParameter, 'list': ListParameter, 'string': StringParameter, 'blob': BlobParameter, 'float': FloatParameter, 'double': DoubleParameter, 'integer': IntegerParameter, 'long': IntegerParameter, 'boolean': BooleanParameter, 'double': FloatParameter, 'member': Parameter, 'file': StringParameter} def get_parameter(operation, name, type_data): """ Returns a Parameter object based on the parameter data passed in. """ if name and 'name' not in type_data: type_data['name'] = name param_cls = type_map[type_data['type']] obj = param_cls(operation, **type_data) return obj botocore-0.29.0/botocore/payload.py0000644000175000017500000001265012254746564016552 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # """ Payloads -------- These payload objects are used to manage the payload (e.g. body) of PUT and POST requests. These bodies are either: * JSON documents that accumulate the values of 1 or more parameters. In this situation, the values are accumulated in a Python dict and then marshalled to a JSON string. * XML documents that accumulate the values of 1 or more parameters. In this case, the xml fragments are accumulated and a complete XML document is assembled as a string. * Literal values such as raw strings or file-like objects that need to be copied into the request body. """ import logging from botocore.compat import json logger = logging.getLogger(__name__) class Payload(object): def __init__(self): self._literal_value = None @property def literal_value(self): return self._literal_value @literal_value.setter def literal_value(self, literal_value): self._literal_value = literal_value def add_param(self, param, value, label=None): """ Add a parameter to this JSON payload. """ self._literal_value = value def getvalue(self): return self._literal_value class JSONPayload(Payload): """ A JSON payload. The parameters are added to the payload one at a time and the complete JSON body is returned as a string by the ``getvalue`` method. """ def __init__(self): super(JSONPayload, self).__init__() self._value = {} def add_param(self, param, value, label=None): """ Add a parameter to this JSON payload. """ param.store_value_json(value, self._value, label) def getvalue(self): """ Return the value of the payload as a JSON string. """ value = self._literal_value if self._value: value = json.dumps(self._value) return value class XMLPayload(Payload): """ XML Payload. One or more parameters may be added to this payload and the complete XML body is constructed and returned as a string by the ``getvalue`` method. There are two types of XML payloads encountered. In the case of S3 and CloudFront requests, one (and only one) parameter of an operation can have a ``payload=true`` attribute. In this case, the value of that single parameter is the complete body of the XML payload. In the case of Route53 requests, the entire input is treated as the XML payload. It will have one or more members whose values must be added to the final XML document. In addition, the input may have other parameters that need to be added to the URI or to a header and these parameters are not added to the payload. To distinquish between these two types, we use two factors: * ``root_element_name`` attribute. Route53 payloads have a ``root_element_name`` attribute but S3 payloads do not. * A ``payload=True`` attribute. Route53 payloads do not have this attribute but S3 and CloudFront do. I'm not sure if this is the best way to discriminate between the two types but it seems effective. Alternatively, the ``literal_value`` property can be set and this value will be returned as-is by the ``getvalue`` method. """ def __init__(self, root_element_name, namespace=None): super(XMLPayload, self).__init__() self.root_element_name = root_element_name self.namespace = namespace self._elements = [] self._payload = False def add_param(self, param, value, label=None): if hasattr(param, 'payload') and param.payload: self._payload = True self._elements.append(param.to_xml(value, label)) def _assemble_xml(self): s = '<%s' % self.root_element_name if self.namespace: s += ' xmlns="%s"' % self.namespace s += '>' for element in self._elements: s += element s += '' % self.root_element_name logger.debug('assembled XML: %s', s) return s def getvalue(self): value = self._literal_value if len(self._elements) > 0: if self.root_element_name and not self._payload: value = self._assemble_xml() else: value = self._elements[0] return value botocore-0.29.0/botocore/provider.py0000644000175000017500000000330512254746564016750 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # class Provider(object): def __init__(self, session, name): self.session = session self.name = name self._services = None def __repr__(self): return 'Provider(%s)' % self.name @property def services(self): if self._services is None: self._services = [self.session.get_service(sn) for sn in self.session.get_available_services()] return self._services def get_provider(session, provider_name): return Provider(session, provider_name) botocore-0.29.0/botocore/response.py0000644000175000017500000003665012254746566016767 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import sys import xml.etree.cElementTree from botocore import ScalarTypes from .hooks import first_non_none_response from botocore.compat import json import logging logger = logging.getLogger(__name__) class Response(object): def __init__(self, session, operation): self.session = session self.operation = operation self.value = {} def parse(self, s, encoding): pass def get_value(self): value = '' if self.value: value = self.value return value def merge_header_values(self, headers): pass class XmlResponse(Response): def __init__(self, session, operation): Response.__init__(self, session, operation) self.tree = None self.element_map = {} self.value = {} self._parent = None def clark_notation(self, tag): return '{%s}%s' % (self.operation.service.xmlnamespace, tag) def get_element_base_tag(self, elem): if '}' in elem.tag: elem_tag = elem.tag.split('}')[1] else: elem_tag = elem.tag return elem_tag def parse(self, s, encoding): parser = xml.etree.cElementTree.XMLParser( target=xml.etree.cElementTree.TreeBuilder(), encoding=encoding) parser.feed(s) self.tree = parser.close() if self.operation.output: self.build_element_map(self.operation.output, 'root') self.start(self.tree) def get_response_metadata(self): rmd = {} self.value['ResponseMetadata'] = rmd rmd_elem = self.tree.find(self.clark_notation('ResponseMetadata')) if rmd_elem is not None: rmd_elem.tail = True request_id = rmd_elem.find(self.clark_notation('RequestId')) else: request_id = self.tree.find(self.clark_notation('requestId')) if request_id is None: request_id = self.tree.find(self.clark_notation('RequestId')) if request_id is None: request_id = self.tree.find('RequestID') if request_id is not None: request_id.tail = True rmd['RequestId'] = request_id.text.strip() def _get_error_data(self, error_elem): data = {} for elem in error_elem: elem.tail = True data[self.get_element_base_tag(elem)] = elem.text return data def get_response_errors(self): errors = None error_elems = self.tree.find('Errors') if error_elems is not None: error_elems.tail = True errors = [self._get_error_data(e) for e in error_elems] else: error_elems = self.tree.find(self.clark_notation('Error')) if error_elems is not None: error_elems.tail = True errors = [self._get_error_data(error_elems)] elif self.tree.tag == 'Error': errors = [self._get_error_data(self.tree)] if errors: self.value['Errors'] = errors def build_element_map(self, defn, keyname): xmlname = defn.get('xmlname', keyname) if not xmlname: xmlname = defn.get('shape_name') self.element_map[xmlname] = defn if defn['type'] == 'structure': for member_name in defn['members']: self.build_element_map(defn['members'][member_name], member_name) elif defn['type'] == 'list': self.build_element_map(defn['members'], None) elif defn['type'] == 'map': self.build_element_map(defn['keys'], 'key') self.build_element_map(defn['members'], 'value') def find(self, parent, tag): tag = tag.split(':')[-1] cn = self.clark_notation(tag) child = parent.find(cn) if child is None: child = parent.find('*/%s' % cn) return child def findall(self, parent, tag): cn = self.clark_notation(tag) children = parent.findall(cn) if not children: try: children = parent.findall('*/%s' % cn) except: pass return children def parent_slow(self, elem, target): for child in elem: if child == target: self._parent = elem break self.parent_slow(child, target) def parent(self, elem): # We need the '..' operator in XPath but only that is only # available in Python versions >= 2.7 if sys.version_info[0] == 2 and sys.version_info[1] == 6: self.parent_slow(self.tree, elem) parent = self._parent self._parent = None else: parent = self.tree.find('.//%s/..' % elem.tag) return parent def get_elem_text(self, elem): data = elem.text if data is not None: data = elem.text.strip() return data def _handle_string(self, elem, shape): data = self.get_elem_text(elem) if not data: children = list(elem) if len(children) == 1: data = self.get_elem_text(children[0]) return data _handle_timestamp = _handle_string _handle_blob = _handle_string def _handle_integer(self, elem, shape): data = self.get_elem_text(elem) if data: data = int(data) return data _handle_long = _handle_integer def _handle_float(self, elem, shape): data = self.get_elem_text(elem) if data: data = float(data) return data _handle_double = _handle_float def _handle_boolean(self, elem, shape): return True if elem.text.lower() == 'true' else False def _handle_structure(self, elem, shape): new_data = {} xmlname = shape.get('xmlname') if xmlname: tagname = self.get_element_base_tag(elem) if xmlname != tagname: return new_data for member_name in shape['members']: member_shape = shape['members'][member_name] xmlname = member_shape.get('xmlname', member_name) child = self.find(elem, xmlname) if child is not None: new_data[member_name] = self.handle_elem( member_name, child, member_shape) return new_data def _handle_list(self, elem, shape): xmlname = shape['members'].get('xmlname', 'member') children = self.findall(elem, xmlname) if not children and shape.get('flattened'): parent = self.parent(elem) if parent is not None: tagname = self.get_element_base_tag(elem) children = self.findall(parent, tagname) if not children: children = [] return [self.handle_elem(None, child, shape['members']) for child in children] def _handle_map(self, elem, shape): data = {} # First collect all map entries xmlname = shape.get('xmlname', 'entry') keyshape = shape['keys'] valueshape = shape['members'] key_xmlname = keyshape.get('xmlname', 'key') value_xmlname = valueshape.get('xmlname', 'value') members = self.findall(elem, xmlname) if not members: parent = self.parent(elem) if parent is not None: members = self.findall(parent, xmlname) for member in members: key = self.find(member, key_xmlname) value = self.find(member, value_xmlname) cn = self.clark_notation(value_xmlname) value = member.find(cn) key_name = self.handle_elem(None, key, keyshape) data[key_name] = self.handle_elem(key_name, value, valueshape) return data def emit_event(self, tag, shape, value): if 'shape_name' in shape: event = self.session.create_event( 'after-parsed', self.operation.service.endpoint_prefix, self.operation.name, shape['shape_name'], tag) rv = first_non_none_response(self.session.emit(event, shape=shape, value=value), None) if rv: value = rv return value def handle_elem(self, key, elem, shape): handler_name = '_handle_%s' % shape['type'] elem.tail = True if hasattr(self, handler_name): value = getattr(self, handler_name)(elem, shape) value = self.emit_event(key, shape, value) return value else: logger.debug('Unhandled type: %s', shape['type']) def fake_shape(self, elem): shape = {} tags = set() nchildren = 0 for child in elem: tags.add(child) nchildren += 1 if nchildren == 0: shape['type'] = 'string' elif nchildren > 1 and len(tags) == 1: shape['type'] = 'list' shape['members'] = {'type': 'string'} else: shape['type'] = 'structure' shape['members'] = {} for tag in tags: base_tag = self.get_element_base_tag(tag) shape['members'][base_tag] = {'type': 'string'} return shape def start(self, elem): self.value = {} if self.operation.output: for member_name in self.operation.output['members']: member = self.operation.output['members'][member_name] xmlname = member.get('xmlname', member_name) child = self.find(elem, xmlname) if child is None and member['type'] not in ScalarTypes: child = elem if child is not None: self.value[member_name] = self.handle_elem(member_name, child, member) self.get_response_metadata() self.get_response_errors() for child in self.tree: if child.tail is not True: child_tag = self.get_element_base_tag(child) if child_tag not in self.element_map: if not child_tag.startswith(self.operation.name): shape = self.fake_shape(child) self.value[child_tag] = self.handle_elem(child_tag, child, shape) def merge_header_values(self, headers): if self.operation.output: for member_name in self.operation.output['members']: member = self.operation.output['members'][member_name] location = member.get('location') if location == 'header': location_name = member.get('location_name') if location_name in headers: self.value[member_name] = headers[location_name] class JSONResponse(Response): def parse(self, s, encoding): try: decoded = s.decode(encoding) self.value = json.loads(decoded) self.get_response_errors() except Exception as err: logger.debug('Error loading JSON response body, %r', err) def get_response_errors(self): # Most JSON services return a __type in error response bodies. # Unfortunately, ElasticTranscoder does not. It simply returns # a JSON body with a single key, "message". error = None if '__type' in self.value: error_type = self.value['__type'] error = {'Type': error_type} del self.value['__type'] if 'message' in self.value: error['Message'] = self.value['message'] del self.value['message'] code = self._parse_code_from_type(error_type) error['Code'] = code elif 'message' in self.value and len(self.value.keys()) == 1: error = {'Type': 'Unspecified', 'Code': 'Unspecified', 'Message': self.value['message']} del self.value['message'] if error: self.value['Errors'] = [error] def _parse_code_from_type(self, error_type): return error_type.rsplit('#', 1)[-1] class StreamingResponse(Response): def __init__(self, session, operation): Response.__init__(self, session, operation) self.value = {} def parse(self, headers, stream): for member_name in self.operation.output['members']: member_dict = self.operation.output['members'][member_name] if member_dict.get('location') == 'header': header_name = member_dict.get('location_name') if header_name and header_name in headers: self.value[member_name] = headers[header_name] elif member_dict.get('type') == 'blob': if member_dict.get('payload'): if member_dict.get('streaming'): self.value[member_name] = stream def get_response(session, operation, http_response): encoding = 'utf-8' if http_response.encoding: encoding = http_response.encoding content_type = http_response.headers.get('content-type') if content_type and ';' in content_type: content_type = content_type.split(';')[0] logger.debug('Content type from response: %s', content_type) if operation.is_streaming(): streaming_response = StreamingResponse(session, operation) streaming_response.parse(http_response.headers, http_response.raw) return (http_response, streaming_response.get_value()) body = http_response.content logger.debug("Response Body:\n%s", body) if operation.service.type == 'json': json_response = JSONResponse(session, operation) if body: json_response.parse(body, encoding) json_response.merge_header_values(http_response.headers) return (http_response, json_response.get_value()) # We are defaulting to an XML response handler because many query # services send XML error responses but do not include a Content-Type # header. xml_response = XmlResponse(session, operation) if body: xml_response.parse(body, encoding) xml_response.merge_header_values(http_response.headers) return (http_response, xml_response.get_value()) botocore-0.29.0/botocore/retryhandler.py0000644000175000017500000003336612254746564017633 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import random import functools import logging from binascii import crc32 from botocore.vendored.requests import ConnectionError from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError from botocore.exceptions import ChecksumError logger = logging.getLogger(__name__) # The only supported error for now is GENERAL_CONNECTION_ERROR # which maps to requests generic ConnectionError. If we're able # to get more specific exceptions from requests we can update # this mapping with more specific exceptions. EXCEPTION_MAP = { 'GENERAL_CONNECTION_ERROR': [ConnectionError, ClosedPoolError], } def delay_exponential(base, growth_factor, attempts): """Calculate time to sleep based on exponential function. The format is:: base * growth_factor ^ (attempts - 1) If ``base`` is set to 'rand' then a random number between 0 and 1 will be used as the base. Base must be greater than 0, otherwise a ValueError will be raised. """ if base == 'rand': base = random.random() elif base <= 0: raise ValueError("The 'base' param must be greater than 0, " "got: %s" % base) time_to_sleep = base * (growth_factor ** (attempts - 1)) return time_to_sleep def create_exponential_delay_function(base, growth_factor): """Create an exponential delay function based on the attempts. This is used so that you only have to pass it the attempts parameter to calculate the delay. """ return functools.partial( delay_exponential, base=base, growth_factor=growth_factor) def create_retry_handler(config, operation_name=None): checker = create_checker_from_retry_config( config, operation_name=operation_name) action = create_retry_action_from_config( config, operation_name=operation_name) return RetryHandler(checker=checker, action=action) def create_retry_action_from_config(config, operation_name=None): # The spec has the possibility of supporting per policy # actions, but right now, we assume this comes from the # default section, which means that delay functions apply # for every policy in the retry config (per service). delay_config = config['__default__']['delay'] if delay_config['type'] == 'exponential': return create_exponential_delay_function( base=delay_config['base'], growth_factor=delay_config['growth_factor']) def create_checker_from_retry_config(config, operation_name=None): checkers = [] max_attempts = None retryable_exceptions = [] if '__default__' in config: policies = config['__default__'].get('policies', []) max_attempts = config['__default__']['max_attempts'] for key in policies: current_config = policies[key] checkers.append(_create_single_checker(current_config)) retry_exception = _extract_retryable_exception(current_config) if retry_exception is not None: retryable_exceptions.extend(retry_exception) if operation_name is not None and config.get(operation_name) is not None: operation_policies = config[operation_name]['policies'] for key in operation_policies: checkers.append(_create_single_checker(operation_policies[key])) retry_exception = _extract_retryable_exception( operation_policies[key]) if retry_exception is not None: retryable_exceptions.extend(retry_exception) if len(checkers) == 1: # Don't need to use a MultiChecker return MaxAttemptsDecorator(checkers[0], max_attempts=max_attempts) else: multi_checker = MultiChecker(checkers) return MaxAttemptsDecorator( multi_checker, max_attempts=max_attempts, retryable_exceptions=tuple(retryable_exceptions)) def _create_single_checker(config): if 'response' in config['applies_when']: return _create_single_response_checker( config['applies_when']['response']) elif 'socket_errors' in config['applies_when']: return ExceptionRaiser() def _create_single_response_checker(response): if 'service_error_code' in response: checker = ServiceErrorCodeChecker( status_code=response['http_status_code'], error_code=response['service_error_code']) elif 'http_status_code' in response: checker = HTTPStatusCodeChecker( status_code=response['http_status_code']) elif 'crc32body' in response: checker = CRC32Checker(header=response['crc32body']) else: # TODO: send a signal. raise ValueError("Unknown retry policy: %s" % config) return checker def _extract_retryable_exception(config): applies_when = config['applies_when'] if 'crc32body' in applies_when.get('response', {}): return [ChecksumError] elif 'socket_errors' in applies_when: exceptions = [] for name in applies_when['socket_errors']: exceptions.extend(EXCEPTION_MAP[name]) return exceptions class RetryHandler(object): """Retry handler. The retry handler takes two params, ``checker`` object and an ``action`` object. The ``checker`` object must be a callable object and based on a response and an attempt number, determines whether or not sufficient criteria for a retry has been met. If this is the case then the ``action`` object (which also is a callable) determines what needs to happen in the event of a retry. """ def __init__(self, checker, action): self._checker = checker self._action = action def __call__(self, attempts, response, caught_exception, **kwargs): """Handler for a retry. Intended to be hooked up to an event handler (hence the **kwargs), this will process retries appropriately. """ if self._checker(attempts, response, caught_exception): result = self._action(attempts=attempts) logger.debug("Retry needed, action of: %s", result) return result logger.debug("No retry needed.") class BaseChecker(object): """Base class for retry checkers. Each class is responsible for checking a single criteria that determines whether or not a retry should not happen. """ def __call__(self, attempt_number, response, caught_exception): """Determine if retry criteria matches. Note that either ``response`` is not None and ``caught_exception`` is None or ``response`` is None and ``caught_exception`` is not None. :type attempt_number: int :param attempt_number: The total number of times we've attempted to send the request. :param response: The HTTP response (if one was received). :type caught_exception: Exception :param caught_exception: Any exception that was caught while trying to send the HTTP response. :return: True, if the retry criteria matches (and therefore a retry should occur. False if the criteria does not match. """ # The default implementation allows subclasses to not have to check # whether or not response is None or not. if response is not None: return self._check_response(attempt_number, response) elif caught_exception is not None: return self._check_caught_exception(attempt_number, caught_exception) else: raise ValueError("Both response and caught_exception are None.") def _check_response(self, attempt_number, response): pass def _check_caught_exception(self, attempt_number, caught_exception): pass class MaxAttemptsDecorator(BaseChecker): """Allow retries up to a maximum number of attempts. This will pass through calls to the decorated retry checker, provided that the number of attempts does not exceed max_attempts. It will also catch any retryable_exceptions passed in. Once max_attempts has been exceeded, then False will be returned or the retryable_exceptions that was previously being caught will be raised. """ def __init__(self, checker, max_attempts, retryable_exceptions=None): self._checker = checker self._max_attempts = max_attempts self._retryable_exceptions = retryable_exceptions def __call__(self, attempt_number, response, caught_exception): should_retry = self._should_retry(attempt_number, response, caught_exception) if should_retry: if attempt_number >= self._max_attempts: logger.debug("Reached the maximum number of retry " "attempts: %s", attempt_number) return False else: return should_retry else: return False def _should_retry(self, attempt_number, response, caught_exception): if self._retryable_exceptions and \ attempt_number < self._max_attempts: try: return self._checker(attempt_number, response, caught_exception) except self._retryable_exceptions as e: logger.debug("retry needed, retryable exception caught: %s", e, exc_info=True) return True else: # If we've exceeded the max attempts we just let the exception # propogate if one has occurred. return self._checker(attempt_number, response, caught_exception) class HTTPStatusCodeChecker(BaseChecker): def __init__(self, status_code): self._status_code = status_code def _check_response(self, attempt_number, response): if response[0].status_code == self._status_code: logger.debug( "retry needed: retryable HTTP status code received: %s", self._status_code) return True else: return False class ServiceErrorCodeChecker(BaseChecker): def __init__(self, status_code, error_code): self._status_code = status_code self._error_code = error_code def _check_response(self, attempt_number, response): if response[0].status_code == self._status_code: if any([e.get('Code') == self._error_code for e in response[1].get('Errors', [])]): logger.debug( "retry needed: matching HTTP status and error code seen: " "%s, %s", self._status_code, self._error_code) return True return False class MultiChecker(BaseChecker): def __init__(self, checkers): self._checkers = checkers def __call__(self, attempt_number, response, caught_exception): for checker in self._checkers: checker_response = checker(attempt_number, response, caught_exception) if checker_response: return checker_response return False class CRC32Checker(BaseChecker): def __init__(self, header): # The header where the expected crc32 is located. self._header_name = header def _check_response(self, attempt_number, response): http_response = response[0] expected_crc = http_response.headers.get(self._header_name) if expected_crc is None: logger.debug("crc32 check skipped, the %s header is not " "in the http response.", self._header_name) else: actual_crc32 = crc32(response[0].content) & 0xffffffff if not actual_crc32 == int(expected_crc): logger.debug( "retry needed: crc32 check failed, expected != actual: " "%s != %s", int(expected_crc), actual_crc32) raise ChecksumError(checksum_type='crc32', expected_checksum=int(expected_crc), actual_checksum=actual_crc32) class ExceptionRaiser(BaseChecker): """Raise any caught exceptions. This class will raise any non None ``caught_exception``. """ def _check_caught_exception(self, attempt_number, caught_exception): # This is implementation specific, but this class is useful by # coordinating with the MaxAttemptsDecorator. # The MaxAttemptsDecorator has a list of exceptions it should catch # and retry, but something needs to come along and actually raise the # caught_exception. That's what this class is being used for. If # the MaxAttemptsDecorator is not interested in retrying the exception # then this exception just propogates out past the retry code. raise caught_exception botocore-0.29.0/botocore/service.py0000644000175000017500000002145112254746566016562 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import logging from .endpoint import get_endpoint from .operation import Operation from .waiter import Waiter from .exceptions import ServiceNotInRegionError, NoRegionError logger = logging.getLogger(__name__) class Service(object): """ A service, such as Elastic Compute Cloud (EC2). :ivar api_version: A string containing the API version this service is using. :ivar name: The full name of the service. :ivar service_name: The canonical name of the service. :ivar regions: A dict where each key is a region name and the optional value is an endpoint for that region. :ivar protocols: A list of protocols supported by the service. """ WAITER_CLASS = Waiter def __init__(self, session, provider, service_name, path='/', port=None): self.global_endpoint = None self.timestamp_format = 'iso8601' sdata = session.get_service_data(service_name) self.__dict__.update(sdata) self._operations_data = self.__dict__.pop('operations') self._operations = None self.session = session self.provider = provider self.path = path self.port = port self.cli_name = service_name if not hasattr(self, 'metadata'): # metadata is an option thing that comes from .extra.json # so if it's not there we just default to an empty dict. self.metadata = {} def _create_operation_objects(self): logger.debug("Creating operation objects for: %s", self) operations = [] for operation_name in self._operations_data: data = self._operations_data[operation_name] data['name'] = operation_name op = Operation(self, data) operations.append(op) return operations def __repr__(self): return 'Service(%s)' % self.endpoint_prefix @property def operations(self): if self._operations is None: self._operations = self._create_operation_objects() return self._operations @property def region_names(self): return self.metadata.get('regions', {}).keys() def _build_endpoint_url(self, host, is_secure): if is_secure: scheme = 'https' else: scheme = 'http' if scheme not in self.metadata['protocols']: raise ValueError('Unsupported protocol: %s' % scheme) endpoint_url = '%s://%s%s' % (scheme, host, self.path) if self.port: endpoint_url += ':%d' % self.port return endpoint_url def get_endpoint(self, region_name=None, is_secure=True, endpoint_url=None): """ Return the Endpoint object for this service in a particular region. :type region_name: str :param region_name: The name of the region. :type is_secure: bool :param is_secure: True if you want the secure (HTTPS) endpoint. :type endpoint_url: str :param endpoint_url: You can explicitly override the default computed endpoint name with this parameter. If this arg is provided then neither ``region_name`` nor ``is_secure`` is used in building the final ``endpoint_url``. ``region_name`` can still be useful for services that require a region name independent of the endpoint_url (for example services that use Signature Version 4, which require a region name for use in the signature calculation). """ if region_name is None: region_name = self.session.get_variable('region') if endpoint_url is not None: # Before getting into any of the region/endpoint # logic, if an endpoint_url is explicitly # provided, just use what's been explicitly passed in. return self._get_endpoint(region_name, endpoint_url) if region_name is None and not self.global_endpoint: # The only time it's ok to *not* provide a region is # if the service is a global_endpoint (e.g. IAM). envvar_name = self.session.env_vars['region'][1] raise NoRegionError(env_var=envvar_name) if region_name not in self.region_names: if self.global_endpoint: # If we haven't provided a region_name and this is a global # endpoint, we can just use the global_endpoint (which is a # string of the hostname of the global endpoint) to construct # the full endpoint_url. endpoint_url = self._build_endpoint_url(self.global_endpoint, is_secure) region_name = 'us-east-1' else: # Otherwise we've specified a region name that is # not supported by the service so we raise # an exception. raise ServiceNotInRegionError(service_name=self.endpoint_prefix, region_name=region_name) # The 'regions' dict can call out the specific hostname # to use for a particular region. If this is the case, # this will have precedence. # TODO: It looks like the region_name overrides shouldn't have the # protocol prefix. Otherwise, it doesn't seem possible to override # the hostname for a region *and* support both http/https. Should # be an easy change but it will be backwards incompatible to anyone # creating their own service descriptions with region overrides. endpoint_url = endpoint_url or self.metadata['regions'][region_name] if endpoint_url is None: # If the entry in the 'regions' dict is None, # then we fall back to the patter of # endpoint_prefix.region.amazonaws.com. host = '%s.%s.amazonaws.com' % (self.endpoint_prefix, region_name) endpoint_url = self._build_endpoint_url(host, is_secure) return self._get_endpoint(region_name, endpoint_url) def _get_endpoint(self, region_name, endpoint_url): event = self.session.create_event('creating-endpoint', self.endpoint_prefix) self.session.emit(event, service=self, region_name=region_name, endpoint_url=endpoint_url) return get_endpoint(self, region_name, endpoint_url) def get_operation(self, operation_name): """ Find an Operation object for a given operation_name. The name provided can be the original camel case name, the Python name or the CLI name. :type operation_name: str :param operation_name: The name of the operation. """ for operation in self.operations: op_names = (operation.name, operation.py_name, operation.cli_name) if operation_name in op_names: return operation return None def get_waiter(self, waiter_name): if waiter_name not in self.waiters: raise ValueError("Waiter does not exist: %s" % waiter_name) config = self.waiters[waiter_name] operation = self.get_operation(config['operation']) return self.WAITER_CLASS(waiter_name, operation, config) def get_service(session, service_name, provider): """ Return a Service object for a given provider name and service name. :type service_name: str :param service_name: The name of the service. :type provider: Provider :param provider: The Provider object associated with the session. """ logger.debug("Creating service object for: %s", service_name) return Service(session, provider, service_name) botocore-0.29.0/botocore/session.py0000644000175000017500000005155612254746566016616 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # """ This module contains the main interface to the botocore package, the Session object. """ import logging import platform import os import copy import shlex import botocore.config import botocore.credentials import botocore.base import botocore.service from botocore.exceptions import ConfigNotFound, EventNotFound, ProfileNotFound from botocore.hooks import HierarchicalEmitter, first_non_none_response from botocore.provider import get_provider from botocore import __version__ from botocore import handlers AllEvents = { 'after-call': '.%s.%s', 'after-parsed': '.%s.%s.%s.%s', 'before-parameter-build': '.%s.%s', 'before-call': '.%s.%s', 'service-created': '', 'creating-endpoint': '.%s', 'before-auth': '.%s', 'needs-retry': '.%s.%s', } """ A dictionary where each key is an event name and the value is the formatting string used to construct a new event. """ EnvironmentVariables = { 'profile': (None, 'BOTO_DEFAULT_PROFILE', None), 'region': ('region', 'BOTO_DEFAULT_REGION', None), 'data_path': ('data_path', 'BOTO_DATA_PATH', None), 'config_file': (None, 'AWS_CONFIG_FILE', '~/.aws/config'), 'access_key': ('aws_access_key_id', 'AWS_ACCESS_KEY_ID', None), 'secret_key': ('aws_secret_access_key', 'AWS_SECRET_ACCESS_KEY', None), 'token': ('aws_security_token', 'AWS_SECURITY_TOKEN', None), 'provider': ('provider', 'BOTO_PROVIDER_NAME', 'aws') } """ A default dictionary that maps the logical names for session variables to the specific environment variables and configuration file names that contain the values for these variables. When creating a new Session object, you can pass in your own dictionary to remap the logical names or to add new logical names. You can then get the current value for these variables by using the ``get_variable`` method of the :class:`botocore.session.Session` class. The default set of logical variable names are: * profile - Default profile name you want to use. * region - Default region name to use, if not otherwise specified. * data_path - Additional directories to search for data files. * config_file - Location of a Boto config file. * access_key - The AWS access key part of your credentials. * secret_key - The AWS secret key part of your credentials. * token - The security token part of your credentials (session tokens only) * provider - The name of the service provider (e.g. aws) These form the keys of the dictionary. The values in the dictionary are tuples of (, , / Python/ / Where: - agent_name is the value of the `user_agent_name` attribute of the session object (`Boto` by default). - agent_version is the value of the `user_agent_version` attribute of the session object (the botocore version by default). by default. - py_ver is the version of the Python interpreter beng used. - plat_name is the name of the platform (e.g. Darwin) - plat_ver is the version of the platform """ return '%s/%s Python/%s %s/%s' % (self.user_agent_name, self.user_agent_version, platform.python_version(), platform.system(), platform.release()) def get_data(self, data_path): """ Retrieve the data associated with `data_path`. :type data_path: str :param data_path: The path to the data you wish to retrieve. """ return botocore.base.get_data(self, data_path) def get_service_data(self, service_name): """ Retrieve the fully merged data associated with a service. """ data_path = '%s/%s' % (self.provider.name, service_name) service_data = self.get_data(data_path) return service_data def get_available_services(self): """ Return a list of names of available services. """ data_path = '%s' % self.provider.name return self.get_data(data_path) def get_service(self, service_name): """ Get information about a service. :type service_name: str :param service_name: The name of the service (e.g. 'ec2') :returns: :class:`botocore.service.Service` """ service = botocore.service.get_service(self, service_name, self.provider) event = self.create_event('service-created') self._events.emit(event, service=service) return service def set_debug_logger(self, logger_name='botocore'): """ Convenience function to quickly configure full debug output to go to the console. """ self.set_stream_logger(logger_name, logging.DEBUG) def set_stream_logger(self, logger_name, log_level, stream=None, format_string=None): """ Convenience method to configure a stream logger. :type logger_name: str :param logger_name: The name of the logger to configure :type log_level: str :param log_level: The log level to set for the logger. This is any param supported by the ``.setLevel()`` method of a ``Log`` object. :type stream: file :param stream: A file like object to log to. If none is provided then sys.stderr will be used. :type format_string: str :param format_string: The format string to use for the log formatter. If none is provided this will default to ``self.FmtString``. """ log = logging.getLogger(logger_name) log.setLevel(logging.DEBUG) ch = logging.StreamHandler(stream) ch.setLevel(log_level) # create formatter if format_string is None: format_string = self.FmtString formatter = logging.Formatter(format_string) # add formatter to ch ch.setFormatter(formatter) # add ch to logger log.addHandler(ch) def set_file_logger(self, log_level, path, logger_name='botocore'): """ Convenience function to quickly configure any level of logging to a file. :type log_level: int :param log_level: A log level as specified in the `logging` module :type path: string :param path: Path to the log file. The file will be created if it doesn't already exist. """ log = logging.getLogger(logger_name) log.setLevel(logging.DEBUG) # create console handler and set level to debug ch = logging.FileHandler(path) ch.setLevel(log_level) # create formatter formatter = logging.Formatter(self.FmtString) # add formatter to ch ch.setFormatter(formatter) # add ch to logger log.addHandler(ch) def register(self, event_name, handler, unique_id=None): """Register a handler with an event. :type event_name: str :param event_name: The name of the event. :type handler: callable :param handler: The callback to invoke when the event is emitted. This object must be callable, and must accept ``**kwargs``. If either of these preconditions are not met, a ``ValueError`` will be raised. :type unique_id: str :param unique_id: An optional identifier to associate with the registration. A unique_id can only be used once for the entire session registration (unless it is unregistered). This can be used to prevent an event handler from being registered twice. """ self._events.register(event_name, handler, unique_id) def unregister(self, event_name, handler=None, unique_id=None): """Unregister a handler with an event. :type event_name: str :param event_name: The name of the event. :type handler: callable :param handler: The callback to unregister. :type unique_id: str :param unique_id: A unique identifier identifying the callback to unregister. You can provide either the handler or the unique_id, you do not have to provide both. """ self._events.unregister(event_name, handler=handler, unique_id=unique_id) def register_event(self, event_name, fmtstr): """ Register a new event. The event will be added to ``AllEvents`` and will then be able to be created using ``create_event``. :type event_name: str :param event_name: The base name of the event. :type fmtstr: str :param fmtstr: The formatting string for the event. """ if event_name not in AllEvents: AllEvents[event_name] = fmtstr def create_event(self, event_name, *fmtargs): """ Creates a new event string that can then be emitted. You could just create it manually, since it's just a string but this helps to define the range of known events. :type event_name: str :param event_name: The base name of the new event. :type fmtargs: tuple :param fmtargs: A tuple of values that will be used as the arguments pass to the string formatting operation. The actual values passed depend on the type of event you are creating. """ if event_name in AllEvents: fmt_string = AllEvents[event_name] if fmt_string: event = event_name + (fmt_string % fmtargs) else: event = event_name return event raise EventNotFound(event_name=event_name) def emit(self, event_name, **kwargs): return self._events.emit(event_name, **kwargs) def emit_first_non_none_response(self, event_name, **kwargs): responses = self._events.emit(event_name, **kwargs) return first_non_none_response(responses) def get_session(env_vars=None): """ Return a new session object. """ return Session(env_vars) botocore-0.29.0/botocore/translate.py0000644000175000017500000004773512254746566017134 0ustar takakitakaki# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # """Translate the raw json files into python specific descriptions.""" import os import re from copy import deepcopy from botocore.compat import OrderedDict, json from botocore import xform_name class ModelFiles(object): """Container object to hold all the various parsed json files. Includes: * The json service description. * The _regions.json file. * The _retry.json file. * The .extra.json enhancements file. * The name of the service. """ def __init__(self, model, regions, retry, enhancements, name=''): self.model = model self.regions = regions self.retry = retry self.enhancements = enhancements self.name = name def load_model_files(args): model = json.load(open(args.modelfile), object_pairs_hook=OrderedDict) regions = json.load(open(args.regions_file), object_pairs_hook=OrderedDict) retry = json.load(open(args.retry_file), object_pairs_hook=OrderedDict) enhancements = _load_enhancements_file(args.enhancements_file) service_name = os.path.splitext(os.path.basename(args.modelfile))[0] return ModelFiles(model, regions, retry, enhancements, name=service_name) def _load_enhancements_file(file_path): if not os.path.isfile(file_path): return {} else: return json.load(open(file_path), object_pairs_hook=OrderedDict) def translate(model): new_model = deepcopy(model.model) new_model.update(model.enhancements.get('extra', {})) try: del new_model['pagination'] except KeyError: pass handle_op_renames(new_model, model.enhancements) handle_remove_deprecated_params(new_model, model.enhancements) handle_remove_deprecated_operations(new_model, model.enhancements) handle_filter_documentation(new_model, model.enhancements) add_pagination_configs( new_model, model.enhancements.get('pagination', {})) add_waiter_configs( new_model, model.enhancements.get('waiters', {})) # Merge in any per operation overrides defined in the .extras.json file. merge_dicts(new_model['operations'], model.enhancements.get('operations', {})) add_retry_configs( new_model, model.retry.get('retry', {}), definitions=model.retry.get('definitions', {})) return new_model def handle_op_renames(new_model, enhancements): # This allows for operations to be renamed. The only # implemented transformation is removing part of the operation name # (because that's all we currently need.) remove = enhancements.get('transformations', {}).get( 'operation-name', {}).get('remove') if remove is not None: # We're going to recreate the dictionary because we want to preserve # the order. This is the only option we have unless we have our own # custom OrderedDict. remove_regex = re.compile(remove) operations = new_model['operations'] new_operation = OrderedDict() for key in operations: new_key = remove_regex.sub('', key) new_operation[new_key] = operations[key] new_model['operations'] = new_operation def handle_remove_deprecated_operations(new_model, enhancements): # This removes any operation whose documentation string contains # the specified phrase that marks a deprecated parameter. keyword = enhancements.get('transformations', {}).get( 'remove-deprecated-operations', {}).get('deprecated_keyword') remove = [] if keyword is not None: operations = new_model['operations'] for op_name in operations: operation = operations[op_name] if operation: docs = operation['documentation'] if docs and docs.find(keyword) >= 0: remove.append(op_name) for op in remove: del new_model['operations'][op] def handle_remove_deprecated_params(new_model, enhancements): # This removes any parameter whose documentation string contains # the specified phrase that marks a deprecated parameter. keyword = enhancements.get('transformations', {}).get( 'remove-deprecated-params', {}).get('deprecated_keyword') if keyword is not None: operations = new_model['operations'] for op_name in operations: operation = operations[op_name] params = operation.get('input', {}).get('members') if params: new_params = OrderedDict() for param_name in params: param = params[param_name] docs = param['documentation'] if docs and docs.find(keyword) >= 0: continue new_params[param_name] = param operation['input']['members'] = new_params def _filter_param_doc(param, replacement, regex): # Recurse into complex parameters looking for documentation. doc = param.get('documentation') if doc: param['documentation'] = regex.sub(replacement, doc) if param['type'] == 'structure': for member_name in param['members']: member = param['members'][member_name] _filter_param_doc(member, replacement, regex) if param['type'] == 'map': _filter_param_doc(param['keys'], replacement, regex) _filter_param_doc(param['members'], replacement, regex) elif param['type'] == 'list': _filter_param_doc(param['members'], replacement, regex) def handle_filter_documentation(new_model, enhancements): #This provides a way to filter undesireable content (e.g. CDATA) #from documentation strings filter = enhancements.get('transformations', {}).get( 'filter-documentation', {}).get('filter') if filter is not None: filter_regex = re.compile(filter.get('regex', ''), re.DOTALL) replacement = filter.get('replacement') operations = new_model['operations'] for op_name in operations: operation = operations[op_name] doc = operation.get('documentation') if doc: new_doc = filter_regex.sub(replacement, doc) operation['documentation'] = new_doc params = operation.get('input', {}).get('members') if params: for param_name in params: param = params[param_name] _filter_param_doc(param, replacement, filter_regex) def add_pagination_configs(new_model, pagination): # Adding in pagination configs means copying the config to a top level # 'pagination' key in the new model, and it also means adding the # pagination config to each individual operation. # Also, the input_token needs to be transformed to the python specific # name, so we're adding a py_input_token (e.g. NextToken -> next_token). if pagination: new_model['pagination'] = pagination for name in pagination: config = pagination[name] _check_known_pagination_keys(config) if 'py_input_token' not in config: input_token = config['input_token'] if isinstance(input_token, list): py_input_token = [] for token in input_token: py_input_token.append(xform_name(token)) config['py_input_token'] = py_input_token else: config['py_input_token'] = xform_name(input_token) # result_key must be defined if 'result_key' not in config: raise ValueError("Required key 'result_key' is missing from " "from pagination config: %s" % config) if name not in new_model['operations']: raise ValueError("Trying to add pagination config for non " "existent operation: %s" % name) operation = new_model['operations'].get(name) # result_key must match a key in the output. if not isinstance(config['result_key'], list): result_keys = [config['result_key']] else: result_keys = config['result_key'] if result_keys and not operation['output']: raise ValueError("Trying to add pagination config for an " "operation with no output members: %s" % name) for result_key in result_keys: if result_key not in operation['output']['members']: raise ValueError("result_key %r is not an output member: %s" % (result_key, operation['output']['members'].keys())) _check_input_keys_match(config, operation) if operation is None: raise ValueError("Tried to add a pagination config for non " "existent operation '%s'" % name) operation['pagination'] = config.copy() def add_waiter_configs(new_model, waiters): if waiters: denormalized = denormalize_waiters(waiters) # Before adding it to the new model, we need to verify the # final denormalized model. for value in denormalized.values(): if value['operation'] not in new_model['operations']: raise ValueError() new_model['waiters'] = denormalized def denormalize_waiters(waiters): # The waiter configuration is normalized to avoid duplication. # You can inherit defaults, and extend from other definitions. # We're going to denormalize this so that the implementation for # consuming waiters is simple. default = waiters.get('__default__', {}) new_waiters = {} for key, value in waiters.items(): if key.startswith('__'): # Keys that start with '__' are considered abstract/internal # and are only used for inheritance. Because we're going # to denormalize the configs and perform all the lookups # during this translation process, the abstract/internal # configs don't need to make it into the final translated # config so we can just skip these. continue new_waiters[key] = denormalize_single_waiter(value, default, waiters) return new_waiters def denormalize_single_waiter(value, default, waiters): """Denormalize a single waiter config. :param value: The dictionary of a single waiter config, e.g. the ``InstanceRunning`` or ``TableExists`` config. This is the config we're going to denormalize. :param default: The ``__default__`` (if any) configuration. This is needed to resolve the lookup process. :param waiters: The full configuration of the waiters. This is needed if we need to look up at parent class that the current config extends. :return: The denormalized config. :rtype: dict """ # First we need to resolve all the keys based on the inheritance # hierarchy. The lookup process is: # The most bottom/leaf class is ``value``. From there we need # to look up anything it inherits from (denoted via the ``extends`` # key). We need to perform this process recursively until we hit # a config that has no ``extends`` key. # And finally if we haven't found our value yet, we check in the # ``__default__`` key. # So the first thing we need to do is build the lookup chain that # starts with ``value`` and ends with ``__default__``. lookup_chain = [value] current = value while True: if 'extends' not in current: break current = waiters[current.get('extends')] lookup_chain.append(current) lookup_chain.append(default) new_waiter = {} # Now that we have this lookup chain we can build the entire set # of values by starting at the most parent class and walking down # to the children. At each step the child is merged onto the parent's # config items. This is the desired behavior as a child's values # overrides its parents. This is what the ``reversed(...)`` call # is for. for element in reversed(lookup_chain): new_waiter.update(element) # We don't care about 'extends' so we can safely remove that key. new_waiter.pop('extends', {}) # Now we need to resolve the success/failure values. We # want to completely remove the acceptor types. # The logic here is that if there is no success/failure_* variable # defined, it inherits this value from the matching acceptor_* variable. new_waiter['success_type'] = new_waiter.get('success_type', new_waiter.get('acceptor_type')) new_waiter['success_path'] = new_waiter.get('success_path', new_waiter.get('acceptor_path')) new_waiter['success_value'] = new_waiter.get('success_value', new_waiter.get('acceptor_value')) new_waiter['failure_type'] = new_waiter.get('failure_type', new_waiter.get('acceptor_type')) new_waiter['failure_path'] = new_waiter.get('failure_path', new_waiter.get('acceptor_path')) new_waiter['failure_value'] = new_waiter.get('failure_value', new_waiter.get('acceptor_value')) # We can remove acceptor_* vars because they're only used for lookups # and we've already performed this step in the lines above. new_waiter.pop('acceptor_type', '') new_waiter.pop('acceptor_path', '') new_waiter.pop('acceptor_value', '') # Remove any keys with a None value. for key in list(new_waiter.keys()): if new_waiter[key] is None: del new_waiter[key] # Check required keys. for required in ['operation', 'success_type']: if required not in new_waiter: raise ValueError('Missing required waiter configuration ' 'value "%s": %s' % (required, new_waiter)) if new_waiter.get(required) is None: raise ValueError('Required waiter configuration ' 'value cannot be None "%s": %s' % (required, new_waiter)) # Finally, success/failure values can be a scalar or a list. We're going # to just always make them a list. if 'success_value' in new_waiter and not \ isinstance(new_waiter['success_value'], list): new_waiter['success_value'] = [new_waiter['success_value']] if 'failure_value' in new_waiter and not \ isinstance(new_waiter['failure_value'], list): new_waiter['failure_value'] = [new_waiter['failure_value']] _transform_waiter(new_waiter) return new_waiter def _transform_waiter(new_waiter): # This transforms the waiters into a format that's slightly # easier to consume. if 'success_type' in new_waiter: success = {'type': new_waiter.pop('success_type')} if 'success_path' in new_waiter: success['path'] = new_waiter.pop('success_path') if 'success_value' in new_waiter: success['value'] = new_waiter.pop('success_value') new_waiter['success'] = success if 'failure_type' in new_waiter: failure = {'type': new_waiter.pop('failure_type')} if 'failure_path' in new_waiter: failure['path'] = new_waiter.pop('failure_path') if 'failure_value' in new_waiter: failure['value'] = new_waiter.pop('failure_value') new_waiter['failure'] = failure def _check_known_pagination_keys(config): # Verify that the pagination config only has keys we expect to see. expected = set(['input_token', 'py_input_token', 'output_token', 'result_key', 'limit_key', 'more_key']) for key in config: if key not in expected: raise ValueError("Unknown key in pagination config: %s" % key) def _check_input_keys_match(config, operation): input_tokens = config['input_token'] if not isinstance(input_tokens, list): input_tokens = [input_tokens] valid_input_names = operation['input']['members'] for token in input_tokens: if token not in valid_input_names: raise ValueError("input_token refers to a non existent " "input name for operation %s: %s. " "Must be one of: %s" % (operation['name'], token, list(valid_input_names))) if 'limit_key' in config and config['limit_key'] not in valid_input_names: raise ValueError("limit_key refers to a non existent input name for " "operation %s: %s. Must be one of: %s" % ( operation['name'], config['limit_key'], list(valid_input_names))) def add_retry_configs(new_model, retry_model, definitions): if not retry_model: new_model['retry'] = {} return # The service specific retry config is keyed off of the endpoint # prefix as defined in the JSON model. endpoint_prefix = new_model.get('endpoint_prefix', '') service_config = retry_model.get(endpoint_prefix, {}) resolve_references(service_config, definitions) # We want to merge the global defaults with the service specific # defaults, with the service specific defaults taking precedence. # So we use the global defaults as the base. final_retry_config = {'__default__': retry_model.get('__default__', {})} resolve_references(final_retry_config, definitions) # The merge the service specific config on top. merge_dicts(final_retry_config, service_config) new_model['retry'] = final_retry_config def resolve_references(config, definitions): """Recursively replace $ref keys. To cut down on duplication, common definitions can be declared (and passed in via the ``definitions`` attribute) and then references as {"$ref": "name"}, when this happens the reference dict is placed with the value from the ``definition`` dict. This is recursively done. """ for key, value in config.items(): if isinstance(value, dict): if len(value) == 1 and list(value.keys())[0] == '$ref': # Then we need to resolve this reference. config[key] = definitions[list(value.values())[0]] else: resolve_references(value, definitions) def merge_dicts(dict1, dict2): """Given two dict, merge the second dict into the first. The dicts can have arbitrary nesting. """ for key in dict2: if is_sequence(dict2[key]): if key in dict1 and key in dict2: merge_dicts(dict1[key], dict2[key]) else: dict1[key] = dict2[key] else: # At scalar types, we iterate and merge the # current dict that we're on. dict1[key] = dict2[key] def is_sequence(x): return isinstance(x, (list, dict)) botocore-0.29.0/botocore/utils.py0000644000175000017500000000467412254746564016270 0ustar takakitakaki# Copyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # def normalize_url_path(path): if not path: return '/' return remove_dot_segments(path) def remove_dot_segments(url): # RFC 2986, section 5.2.4 "Remove Dot Segments" output = [] while url: if url.startswith('../'): url = url[3:] elif url.startswith('./'): url = url[2:] elif url.startswith('/./'): url = '/' + url[3:] elif url.startswith('/../'): url = '/' + url[4:] if output: output.pop() elif url.startswith('/..'): url = '/' + url[3:] if output: output.pop() elif url.startswith('/.'): url = '/' + url[2:] elif url == '.' or url == '..': url = '' elif url.startswith('//'): # As far as I can tell, this is not in the RFC, # but AWS auth services require consecutive # slashes are removed. url = url[1:] else: if url[0] == '/': next_slash = url.find('/', 1) else: next_slash = url.find('/', 0) if next_slash == -1: output.append(url) url = '' else: output.append(url[:next_slash]) url = url[next_slash:] return ''.join(output) botocore-0.29.0/botocore/waiter.py0000644000175000017500000001641412254746566016420 0ustar takakitakaki# Copyright (c) 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the # "Software"), to deal in the Software without restriction, including # without limitation the rights to use, copy, modify, merge, publish, dis- # tribute, sublicense, and/or sell copies of the Software, and to permit # persons to whom the Software is furnished to do so, subject to the fol- # lowing conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- # ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT # SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, # WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # import jmespath import logging import time from .exceptions import WaiterError logger = logging.getLogger(__name__) class Waiter(object): """Wait for a resource to reach a certain state. In addition to creating this class manually, you can also use ``botocore.service.Service.get_waiter`` to create an instance of ``Waiter```. The typical usage pattern is from a ``Service`` object:: ec2 = session.get_service('ec2') p = ec2.get_operation('RunInstances').call(endpoint, **kwargs)[1] instance_running = ec2.get_waiter('InstanceRunning') instance_id = p['Reservations'][0]['Instances'][0]['InstanceId'] # This will block until the instance reaches a 'running' state. instance_running.wait(instance_ids=[instance_id]) """ def __init__(self, name, operation, config): """ :type name: str :param name: The name of the waiter. :type operation: ``botocore.operation.Operation`` :param operation: The operation associated with the waiter. This is specified in the waiter configuration as the ``operation`` key. :type config: dict :param config: The waiter configuration. """ self.name = name self.operation = operation self.sleep_time = config['interval'] self.max_attempts = config['max_attempts'] self.success = self._process_config(config.get('success')) self.failure = self._process_config(config.get('failure')) def _process_config(self, acceptor_config): if acceptor_config is None: return {} new_config = acceptor_config.copy() if new_config['type'] == 'output' and \ new_config.get('path') is not None: new_config['path'] = jmespath.compile(acceptor_config['path']) return new_config def wait(self, endpoint, **kwargs): """Wait until a resource reaches its success state. Calling this method will block until the waiter reaches its desired state. If the failure state is reached, a ``WaiterError`` is raised. The ``**kwargs`` passed to this method will be forwarded to the operation associated with the waiter. :param endpoint: An instance of ``botocore.endpoint.Endpoint``. """ logger.debug("Waiter %s waiting.", self.name) num_attempts = 0 while num_attempts < self.max_attempts: http_response, parsed = self.operation.call(endpoint, **kwargs) if self.success: if self._matches_acceptor_state(self.success, http_response, parsed): # For the success state, if the acceptor matches then we # break the loop. break if self.failure: if self._matches_acceptor_state(self.failure, http_response, parsed): # For the failure state, if the acceptor matches then we # raise an exception. raise WaiterError( name=self.name, reason='Failure state matched one of: %s' % ', '.join(self.failure['value'])) logger.debug("No acceptor state reached for waiter %s, " "attempt %s/%s, sleeping for: %s", self.name, num_attempts, self.max_attempts, self.sleep_time) num_attempts += 1 time.sleep(self.sleep_time) else: error_msg = ("Max attempts (%s) exceeded for waiter %s without " "reaching a terminal state." % (self.max_attempts, self.name)) logger.debug(error_msg) raise WaiterError(name=self.name, reason=error_msg) def _matches_acceptor_state(self, acceptor, http_response, parsed): if acceptor['type'] == 'output': return self._matches_acceptor_output_type(acceptor, http_response, parsed) elif acceptor['type'] == 'error': return self._matches_acceptor_error_type(acceptor, http_response, parsed) def _matches_acceptor_output_type(self, acceptor, http_response, parsed): if 'path' not in acceptor and not self._get_error_codes_from_response(parsed): # If there's no path specified, then a successful response means # that we've matched the acceptor. return True match = acceptor['path'].search(parsed) return self._path_matches_value(match, acceptor['value']) def _path_matches_value(self, match, value): # Determine if the matched data matches the config value. if match is None: return False elif not isinstance(match, list): # If match is not a list, then we need to perform an exact match, # this is something like Table.TableStatus == 'CREATING' return self._single_value_match(match, value) elif isinstance(match, list): # If ``match`` is a list, then we need to ensure that every element # in ``match`` matches something in the ``value`` list. return all(self._single_value_match(element, value) for element in match) else: return False def _single_value_match(self, match, value): for v in value: if match == v: return True else: return False def _matches_acceptor_error_type(self, acceptor, http_response, parsed): if http_response.status_code >= 400 and 'Errors' in parsed: error_codes = self._get_error_codes_from_response(parsed) for v in acceptor['value']: if v in error_codes: return True return False def _get_error_codes_from_response(self, parsed): errors = set() for error in parsed.get('Errors', []): if 'Code' in error: errors.add(error['Code']) return errors botocore-0.29.0/botocore.egg-info/0000755000175000017500000000000012254751773016233 5ustar takakitakakibotocore-0.29.0/botocore.egg-info/dependency_links.txt0000644000175000017500000000000112254751772022300 0ustar takakitakaki botocore-0.29.0/botocore.egg-info/PKG-INFO0000644000175000017500000000424512254751772017334 0ustar takakitakakiMetadata-Version: 1.1 Name: botocore Version: 0.29.0 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Mitch Garnaat Author-email: garnaat@amazon.com License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, dis- tribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the fol- lowing conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: botocore ======== |Build Status| A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for `AWS-CLI `__. `Documentation `__ .. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop :target: https://travis-ci.org/boto/botocore Platform: UNKNOWN Classifier: Development Status :: 3 - Alpha Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: Natural Language :: English Classifier: License :: OSI Approved :: MIT License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 botocore-0.29.0/botocore.egg-info/requires.txt0000644000175000017500000000005712254751772020634 0ustar takakitakakisix>=1.1.0 jmespath==0.2.1 python-dateutil>=2.1botocore-0.29.0/botocore.egg-info/SOURCES.txt0000644000175000017500000001315312254751772020121 0ustar takakitakakiLICENSE.txt MANIFEST.in README.rst requirements.txt setup.cfg setup.py botocore/__init__.py botocore/auth.py botocore/awsrequest.py botocore/base.py botocore/compat.py botocore/config.py botocore/credentials.py botocore/endpoint.py botocore/exceptions.py botocore/handlers.py botocore/hooks.py botocore/operation.py botocore/paginate.py botocore/parameters.py botocore/payload.py botocore/provider.py botocore/response.py botocore/retryhandler.py botocore/service.py botocore/session.py botocore/translate.py botocore/utils.py botocore/waiter.py botocore.egg-info/PKG-INFO botocore.egg-info/SOURCES.txt botocore.egg-info/dependency_links.txt botocore.egg-info/requires.txt botocore.egg-info/top_level.txt botocore/data/aws/_regions.json botocore/data/aws/_retry.json botocore/data/aws/autoscaling.json botocore/data/aws/cloudformation.json botocore/data/aws/cloudfront.json botocore/data/aws/cloudsearch.json botocore/data/aws/cloudtrail.json botocore/data/aws/cloudwatch.json botocore/data/aws/datapipeline.json botocore/data/aws/directconnect.json botocore/data/aws/dynamodb.json botocore/data/aws/ec2.json botocore/data/aws/elasticache.json botocore/data/aws/elasticbeanstalk.json botocore/data/aws/elastictranscoder.json botocore/data/aws/elb.json botocore/data/aws/emr.json botocore/data/aws/iam.json botocore/data/aws/importexport.json botocore/data/aws/kinesis.json botocore/data/aws/opsworks.json botocore/data/aws/rds.json botocore/data/aws/redshift.json botocore/data/aws/route53.json botocore/data/aws/s3.json botocore/data/aws/ses.json botocore/data/aws/sns.json botocore/data/aws/sqs.json botocore/data/aws/storagegateway.json botocore/data/aws/sts.json botocore/data/aws/support.json botocore/data/aws/swf.json botocore/vendored/__init__.py botocore/vendored/requests/__init__.py botocore/vendored/requests/adapters.py botocore/vendored/requests/api.py botocore/vendored/requests/auth.py botocore/vendored/requests/cacert.pem botocore/vendored/requests/certs.py botocore/vendored/requests/compat.py botocore/vendored/requests/cookies.py botocore/vendored/requests/exceptions.py botocore/vendored/requests/hooks.py botocore/vendored/requests/models.py botocore/vendored/requests/sessions.py botocore/vendored/requests/status_codes.py botocore/vendored/requests/structures.py botocore/vendored/requests/utils.py botocore/vendored/requests/packages/__init__.py botocore/vendored/requests/packages/charade/__init__.py botocore/vendored/requests/packages/charade/__main__.py botocore/vendored/requests/packages/charade/big5freq.py botocore/vendored/requests/packages/charade/big5prober.py botocore/vendored/requests/packages/charade/chardistribution.py botocore/vendored/requests/packages/charade/charsetgroupprober.py botocore/vendored/requests/packages/charade/charsetprober.py botocore/vendored/requests/packages/charade/codingstatemachine.py botocore/vendored/requests/packages/charade/compat.py botocore/vendored/requests/packages/charade/constants.py botocore/vendored/requests/packages/charade/cp949prober.py botocore/vendored/requests/packages/charade/escprober.py botocore/vendored/requests/packages/charade/escsm.py botocore/vendored/requests/packages/charade/eucjpprober.py botocore/vendored/requests/packages/charade/euckrfreq.py botocore/vendored/requests/packages/charade/euckrprober.py botocore/vendored/requests/packages/charade/euctwfreq.py botocore/vendored/requests/packages/charade/euctwprober.py botocore/vendored/requests/packages/charade/gb2312freq.py botocore/vendored/requests/packages/charade/gb2312prober.py botocore/vendored/requests/packages/charade/hebrewprober.py botocore/vendored/requests/packages/charade/jisfreq.py botocore/vendored/requests/packages/charade/jpcntx.py botocore/vendored/requests/packages/charade/langbulgarianmodel.py botocore/vendored/requests/packages/charade/langcyrillicmodel.py botocore/vendored/requests/packages/charade/langgreekmodel.py botocore/vendored/requests/packages/charade/langhebrewmodel.py botocore/vendored/requests/packages/charade/langhungarianmodel.py botocore/vendored/requests/packages/charade/langthaimodel.py botocore/vendored/requests/packages/charade/latin1prober.py botocore/vendored/requests/packages/charade/mbcharsetprober.py botocore/vendored/requests/packages/charade/mbcsgroupprober.py botocore/vendored/requests/packages/charade/mbcssm.py botocore/vendored/requests/packages/charade/sbcharsetprober.py botocore/vendored/requests/packages/charade/sbcsgroupprober.py botocore/vendored/requests/packages/charade/sjisprober.py botocore/vendored/requests/packages/charade/universaldetector.py botocore/vendored/requests/packages/charade/utf8prober.py botocore/vendored/requests/packages/urllib3/__init__.py botocore/vendored/requests/packages/urllib3/_collections.py botocore/vendored/requests/packages/urllib3/connection.py botocore/vendored/requests/packages/urllib3/connectionpool.py botocore/vendored/requests/packages/urllib3/exceptions.py botocore/vendored/requests/packages/urllib3/fields.py botocore/vendored/requests/packages/urllib3/filepost.py botocore/vendored/requests/packages/urllib3/poolmanager.py botocore/vendored/requests/packages/urllib3/request.py botocore/vendored/requests/packages/urllib3/response.py botocore/vendored/requests/packages/urllib3/util.py botocore/vendored/requests/packages/urllib3/contrib/__init__.py botocore/vendored/requests/packages/urllib3/contrib/ntlmpool.py botocore/vendored/requests/packages/urllib3/contrib/pyopenssl.py botocore/vendored/requests/packages/urllib3/packages/__init__.py botocore/vendored/requests/packages/urllib3/packages/ordered_dict.py botocore/vendored/requests/packages/urllib3/packages/six.py botocore/vendored/requests/packages/urllib3/packages/ssl_match_hostname/__init__.pybotocore-0.29.0/botocore.egg-info/top_level.txt0000644000175000017500000000001112254751772020754 0ustar takakitakakibotocore botocore-0.29.0/LICENSE.txt0000644000175000017500000000175712254746564014564 0ustar takakitakakiPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, dis- tribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the fol- lowing conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. botocore-0.29.0/MANIFEST.in0000644000175000017500000000022512254746564014464 0ustar takakitakakiinclude README.rst include LICENSE.txt include requirements.txt include botocore/vendored/requests/cacert.pem recursive-include botocore/data *.json botocore-0.29.0/PKG-INFO0000644000175000017500000000424512254751773014027 0ustar takakitakakiMetadata-Version: 1.1 Name: botocore Version: 0.29.0 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Mitch Garnaat Author-email: garnaat@amazon.com License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, dis- tribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the fol- lowing conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL- ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Description: botocore ======== |Build Status| A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for `AWS-CLI `__. `Documentation `__ .. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop :target: https://travis-ci.org/boto/botocore Platform: UNKNOWN Classifier: Development Status :: 3 - Alpha Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: Natural Language :: English Classifier: License :: OSI Approved :: MIT License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 botocore-0.29.0/README.rst0000644000175000017500000000060112254746564014413 0ustar takakitakakibotocore ======== |Build Status| A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for `AWS-CLI `__. `Documentation `__ .. |Build Status| image:: https://travis-ci.org/boto/botocore.png?branch=develop :target: https://travis-ci.org/boto/botocore botocore-0.29.0/requirements.txt0000644000175000017500000000021212254746564016206 0ustar takakitakakisix==1.1.0 tox==1.4 Sphinx==1.1.3 python-dateutil==2.1 nose==1.3.0 mock==1.0.1 -e git://github.com/boto/jmespath.git@develop#egg=jmespath botocore-0.29.0/setup.cfg0000644000175000017500000000012212254751773014541 0ustar takakitakaki[wheel] universal = 1 [egg_info] tag_build = tag_date = 0 tag_svn_revision = 0 botocore-0.29.0/setup.py0000644000175000017500000000347112254746566014450 0ustar takakitakaki#!/usr/bin/env python """ distutils/setuptools install script. """ import sys import botocore from setuptools import setup, find_packages requires = ['six>=1.1.0', 'jmespath==0.2.1', 'python-dateutil>=2.1'] if sys.version_info[:2] == (2, 6): # For python2.6 we have a few other dependencies. # First we need an ordered dictionary so we use the # 2.6 backport. requires.append('ordereddict==1.1') # Then we need simplejson. This is because we need # a json version that allows us to specify we want to # use an ordereddict instead of a normal dict for the # JSON objects. The 2.7 json module has this. For 2.6 # we need simplejson. requires.append('simplejson==3.3.0') setup( name='botocore', version=botocore.__version__, description='Low-level, data-driven core of boto 3.', long_description=open('README.rst').read(), author='Mitch Garnaat', author_email='garnaat@amazon.com', url='https://github.com/boto/botocore', scripts=[], packages=find_packages(exclude=['tests*']), package_data={'botocore': ['data/*.json', 'data/aws/*.json'], 'botocore.vendored.requests': ['*.pem']}, package_dir={'botocore': 'botocore'}, include_package_data=True, install_requires=requires, license=open("LICENSE.txt").read(), classifiers=( 'Development Status :: 3 - Alpha', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'Natural Language :: English', 'License :: OSI Approved :: MIT License', 'Programming Language :: Python', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', ), )